// Copyright (C) The Arvados Authors. All rights reserved.
//
// SPDX-License-Identifier: AGPL-3.0

package keepstore

import (
	"context"
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"io/ioutil"
	"os"
	"os/exec"
	"path/filepath"
	"regexp"
	"strconv"
	"strings"
	"sync"
	"sync/atomic"
	"syscall"
	"time"

	"git.arvados.org/arvados.git/sdk/go/arvados"
	"github.com/prometheus/client_golang/prometheus"
	"github.com/sirupsen/logrus"
)

func init() {
	driver["Directory"] = newUnixVolume
}

func newUnixVolume(params newVolumeParams) (volume, error) {
	v := &unixVolume{
		uuid:    params.UUID,
		cluster: params.Cluster,
		volume:  params.ConfigVolume,
		logger:  params.Logger,
		metrics: params.MetricsVecs,
	}
	err := json.Unmarshal(params.ConfigVolume.DriverParameters, &v)
	if err != nil {
		return nil, err
	}
	v.logger = v.logger.WithField("Volume", v.DeviceID())
	return v, v.check()
}

func (v *unixVolume) check() error {
	if v.Root == "" {
		return errors.New("DriverParameters.Root was not provided")
	}
	if v.Serialize {
		v.locker = &sync.Mutex{}
	}
	if !strings.HasPrefix(v.Root, "/") {
		return fmt.Errorf("DriverParameters.Root %q does not start with '/'", v.Root)
	}

	// Set up prometheus metrics
	lbls := prometheus.Labels{"device_id": v.DeviceID()}
	v.os.stats.opsCounters, v.os.stats.errCounters, v.os.stats.ioBytes = v.metrics.getCounterVecsFor(lbls)

	_, err := v.os.Stat(v.Root)
	return err
}

// A unixVolume stores and retrieves blocks in a local directory.
type unixVolume struct {
	Root      string // path to the volume's root directory
	Serialize bool

	uuid    string
	cluster *arvados.Cluster
	volume  arvados.Volume
	logger  logrus.FieldLogger
	metrics *volumeMetricsVecs

	// something to lock during IO, typically a sync.Mutex (or nil
	// to skip locking)
	locker sync.Locker

	os osWithStats
}

// DeviceID returns a globally unique ID for the volume's root
// directory, consisting of the filesystem's UUID and the path from
// filesystem root to storage directory, joined by "/". For example,
// the device ID for a local directory "/mnt/xvda1/keep" might be
// "fa0b6166-3b55-4994-bd3f-92f4e00a1bb0/keep".
func (v *unixVolume) DeviceID() string {
	giveup := func(f string, args ...interface{}) string {
		v.logger.Infof(f+"; using hostname:path for volume %s", append(args, v.uuid)...)
		host, _ := os.Hostname()
		return host + ":" + v.Root
	}
	buf, err := exec.Command("findmnt", "--noheadings", "--target", v.Root).CombinedOutput()
	if err != nil {
		return giveup("findmnt: %s (%q)", err, buf)
	}
	findmnt := strings.Fields(string(buf))
	if len(findmnt) < 2 {
		return giveup("could not parse findmnt output: %q", buf)
	}
	fsRoot, dev := findmnt[0], findmnt[1]

	absRoot, err := filepath.Abs(v.Root)
	if err != nil {
		return giveup("resolving relative path %q: %s", v.Root, err)
	}
	realRoot, err := filepath.EvalSymlinks(absRoot)
	if err != nil {
		return giveup("resolving symlinks in %q: %s", absRoot, err)
	}

	// Find path from filesystem root to realRoot
	var fsPath string
	if strings.HasPrefix(realRoot, fsRoot+"/") {
		fsPath = realRoot[len(fsRoot):]
	} else if fsRoot == "/" {
		fsPath = realRoot
	} else if fsRoot == realRoot {
		fsPath = ""
	} else {
		return giveup("findmnt reports mount point %q which is not a prefix of volume root %q", fsRoot, realRoot)
	}

	if !strings.HasPrefix(dev, "/") {
		return giveup("mount %q device %q is not a path", fsRoot, dev)
	}

	fi, err := os.Stat(dev)
	if err != nil {
		return giveup("stat %q: %s", dev, err)
	}
	ino := fi.Sys().(*syscall.Stat_t).Ino

	// Find a symlink in /dev/disk/by-uuid/ whose target is (i.e.,
	// has the same inode as) the mounted device
	udir := "/dev/disk/by-uuid"
	d, err := os.Open(udir)
	if err != nil {
		return giveup("opening %q: %s", udir, err)
	}
	defer d.Close()
	uuids, err := d.Readdirnames(0)
	if err != nil {
		return giveup("reading %q: %s", udir, err)
	}
	for _, uuid := range uuids {
		link := filepath.Join(udir, uuid)
		fi, err = os.Stat(link)
		if err != nil {
			v.logger.WithError(err).Errorf("stat(%q) failed", link)
			continue
		}
		if fi.Sys().(*syscall.Stat_t).Ino == ino {
			return uuid + fsPath
		}
	}
	return giveup("could not find entry in %q matching %q", udir, dev)
}

// BlockTouch sets the timestamp for the given locator to the current time
func (v *unixVolume) BlockTouch(hash string) error {
	p := v.blockPath(hash)
	f, err := v.os.OpenFile(p, os.O_RDWR|os.O_APPEND, 0644)
	if err != nil {
		return err
	}
	defer f.Close()
	if err := v.lock(context.TODO()); err != nil {
		return err
	}
	defer v.unlock()
	if e := v.lockfile(f); e != nil {
		return e
	}
	defer v.unlockfile(f)
	ts := time.Now()
	v.os.stats.TickOps("utimes")
	v.os.stats.Tick(&v.os.stats.UtimesOps)
	err = os.Chtimes(p, ts, ts)
	v.os.stats.TickErr(err)
	return err
}

// Mtime returns the stored timestamp for the given locator.
func (v *unixVolume) Mtime(loc string) (time.Time, error) {
	p := v.blockPath(loc)
	fi, err := v.os.Stat(p)
	if err != nil {
		return time.Time{}, err
	}
	return fi.ModTime(), nil
}

// Lock the locker (if one is in use), open the file for reading, and
// call the given function if and when the file is ready to read.
func (v *unixVolume) getFunc(ctx context.Context, path string, fn func(io.Reader) error) error {
	if err := v.lock(ctx); err != nil {
		return err
	}
	defer v.unlock()
	f, err := v.os.Open(path)
	if err != nil {
		return err
	}
	defer f.Close()
	return fn(newCountingReader(ioutil.NopCloser(f), v.os.stats.TickInBytes))
}

// stat is os.Stat() with some extra sanity checks.
func (v *unixVolume) stat(path string) (os.FileInfo, error) {
	stat, err := v.os.Stat(path)
	if err == nil {
		if stat.Size() < 0 {
			err = os.ErrInvalid
		} else if stat.Size() > BlockSize {
			err = errTooLarge
		}
	}
	return stat, err
}

// BlockRead reads a block from the volume.
func (v *unixVolume) BlockRead(ctx context.Context, hash string, w io.Writer) (int, error) {
	path := v.blockPath(hash)
	stat, err := v.stat(path)
	if err != nil {
		return 0, v.translateError(err)
	}
	var n int64
	err = v.getFunc(ctx, path, func(rdr io.Reader) error {
		n, err = io.Copy(w, rdr)
		if err == nil && n != stat.Size() {
			err = io.ErrUnexpectedEOF
		}
		return err
	})
	return int(n), err
}

// BlockWrite stores a block on the volume. If it already exists, its
// timestamp is updated.
func (v *unixVolume) BlockWrite(ctx context.Context, hash string, data []byte) error {
	if v.isFull() {
		return errFull
	}
	bdir := v.blockDir(hash)
	if err := os.MkdirAll(bdir, 0755); err != nil {
		return fmt.Errorf("error creating directory %s: %s", bdir, err)
	}

	bpath := v.blockPath(hash)
	tmpfile, err := v.os.TempFile(bdir, "tmp"+hash)
	if err != nil {
		return fmt.Errorf("TempFile(%s, tmp%s) failed: %s", bdir, hash, err)
	}
	defer v.os.Remove(tmpfile.Name())
	defer tmpfile.Close()

	if err = v.lock(ctx); err != nil {
		return err
	}
	defer v.unlock()
	n, err := tmpfile.Write(data)
	v.os.stats.TickOutBytes(uint64(n))
	if err != nil {
		return fmt.Errorf("error writing %s: %s", bpath, err)
	}
	if err = tmpfile.Close(); err != nil {
		return fmt.Errorf("error closing %s: %s", tmpfile.Name(), err)
	}
	// ext4 uses a low-precision clock and effectively backdates
	// files by up to 10 ms, sometimes across a 1-second boundary,
	// which produces confusing results in logs and tests.  We
	// avoid this by setting the output file's timestamps
	// explicitly, using a higher resolution clock.
	ts := time.Now()
	v.os.stats.TickOps("utimes")
	v.os.stats.Tick(&v.os.stats.UtimesOps)
	if err = os.Chtimes(tmpfile.Name(), ts, ts); err != nil {
		return fmt.Errorf("error setting timestamps on %s: %s", tmpfile.Name(), err)
	}
	if err = v.os.Rename(tmpfile.Name(), bpath); err != nil {
		return fmt.Errorf("error renaming %s to %s: %s", tmpfile.Name(), bpath, err)
	}
	return nil
}

var blockDirRe = regexp.MustCompile(`^[0-9a-f]+$`)
var blockFileRe = regexp.MustCompile(`^[0-9a-f]{32}$`)

func (v *unixVolume) Index(ctx context.Context, prefix string, w io.Writer) error {
	rootdir, err := v.os.Open(v.Root)
	if err != nil {
		return err
	}
	v.os.stats.TickOps("readdir")
	v.os.stats.Tick(&v.os.stats.ReaddirOps)
	subdirs, err := rootdir.Readdirnames(-1)
	rootdir.Close()
	if err != nil {
		return err
	}
	for _, subdir := range subdirs {
		if ctx.Err() != nil {
			return ctx.Err()
		}
		if !strings.HasPrefix(subdir, prefix) && !strings.HasPrefix(prefix, subdir) {
			// prefix excludes all blocks stored in this dir
			continue
		}
		if !blockDirRe.MatchString(subdir) {
			continue
		}
		blockdirpath := filepath.Join(v.Root, subdir)

		var dirents []os.DirEntry
		for attempt := 0; ; attempt++ {
			v.os.stats.TickOps("readdir")
			v.os.stats.Tick(&v.os.stats.ReaddirOps)
			dirents, err = os.ReadDir(blockdirpath)
			if ctx.Err() != nil {
				return ctx.Err()
			} else if err == nil {
				break
			} else if attempt < 5 && strings.Contains(err.Error(), "errno 523") {
				// EBADCOOKIE (NFS stopped accepting
				// our readdirent cookie) -- retry a
				// few times before giving up
				v.logger.WithError(err).Printf("retry after error reading %s", blockdirpath)
				continue
			} else {
				return err
			}
		}

		for _, dirent := range dirents {
			if ctx.Err() != nil {
				return ctx.Err()
			}
			fileInfo, err := dirent.Info()
			if os.IsNotExist(err) {
				// File disappeared between ReadDir() and now
				continue
			} else if err != nil {
				v.logger.WithError(err).Errorf("error getting FileInfo for %q in %q", dirent.Name(), blockdirpath)
				return err
			}
			name := fileInfo.Name()
			if !strings.HasPrefix(name, prefix) {
				continue
			}
			if !blockFileRe.MatchString(name) {
				continue
			}
			_, err = fmt.Fprint(w,
				name,
				"+", fileInfo.Size(),
				" ", fileInfo.ModTime().UnixNano(),
				"\n")
			if err != nil {
				return fmt.Errorf("error writing: %s", err)
			}
		}
	}
	return nil
}

// BlockTrash trashes the block data from the unix storage.  If
// BlobTrashLifetime == 0, the block is deleted; otherwise, the block
// is renamed as path/{loc}.trash.{deadline}, where deadline = now +
// BlobTrashLifetime.
func (v *unixVolume) BlockTrash(loc string) error {
	// Touch() must be called before calling Write() on a block.  Touch()
	// also uses lockfile().  This avoids a race condition between Write()
	// and Trash() because either (a) the file will be trashed and Touch()
	// will signal to the caller that the file is not present (and needs to
	// be re-written), or (b) Touch() will update the file's timestamp and
	// Trash() will read the correct up-to-date timestamp and choose not to
	// trash the file.
	if err := v.lock(context.TODO()); err != nil {
		return err
	}
	defer v.unlock()
	p := v.blockPath(loc)
	f, err := v.os.OpenFile(p, os.O_RDWR|os.O_APPEND, 0644)
	if err != nil {
		return err
	}
	defer f.Close()
	if e := v.lockfile(f); e != nil {
		return e
	}
	defer v.unlockfile(f)

	// If the block has been PUT in the last blobSignatureTTL
	// seconds, return success without removing the block. This
	// protects data from garbage collection until it is no longer
	// possible for clients to retrieve the unreferenced blocks
	// anyway (because the permission signatures have expired).
	if fi, err := v.os.Stat(p); err != nil {
		return err
	} else if time.Since(fi.ModTime()) < v.cluster.Collections.BlobSigningTTL.Duration() {
		return nil
	}

	if v.cluster.Collections.BlobTrashLifetime == 0 {
		return v.os.Remove(p)
	}
	return v.os.Rename(p, fmt.Sprintf("%v.trash.%d", p, time.Now().Add(v.cluster.Collections.BlobTrashLifetime.Duration()).Unix()))
}

// BlockUntrash moves block from trash back into store
// Look for path/{loc}.trash.{deadline} in storage,
// and rename the first such file as path/{loc}
func (v *unixVolume) BlockUntrash(hash string) error {
	v.os.stats.TickOps("readdir")
	v.os.stats.Tick(&v.os.stats.ReaddirOps)
	files, err := ioutil.ReadDir(v.blockDir(hash))
	if err != nil {
		return err
	}

	if len(files) == 0 {
		return os.ErrNotExist
	}

	foundTrash := false
	prefix := fmt.Sprintf("%v.trash.", hash)
	for _, f := range files {
		if strings.HasPrefix(f.Name(), prefix) {
			foundTrash = true
			err = v.os.Rename(v.blockPath(f.Name()), v.blockPath(hash))
			if err == nil {
				break
			}
		}
	}

	if foundTrash == false {
		return os.ErrNotExist
	}

	return nil
}

// blockDir returns the fully qualified directory name for the directory
// where loc is (or would be) stored on this volume.
func (v *unixVolume) blockDir(loc string) string {
	return filepath.Join(v.Root, loc[0:3])
}

// blockPath returns the fully qualified pathname for the path to loc
// on this volume.
func (v *unixVolume) blockPath(loc string) string {
	return filepath.Join(v.blockDir(loc), loc)
}

// isFull returns true if the free space on the volume is less than
// MinFreeKilobytes.
func (v *unixVolume) isFull() (isFull bool) {
	fullSymlink := v.Root + "/full"

	// Check if the volume has been marked as full in the last hour.
	if link, err := os.Readlink(fullSymlink); err == nil {
		if ts, err := strconv.Atoi(link); err == nil {
			fulltime := time.Unix(int64(ts), 0)
			if time.Since(fulltime).Hours() < 1.0 {
				return true
			}
		}
	}

	if avail, err := v.FreeDiskSpace(); err == nil {
		isFull = avail < BlockSize
	} else {
		v.logger.WithError(err).Errorf("%s: FreeDiskSpace failed", v.DeviceID())
		isFull = false
	}

	// If the volume is full, timestamp it.
	if isFull {
		now := fmt.Sprintf("%d", time.Now().Unix())
		os.Symlink(now, fullSymlink)
	}
	return
}

// FreeDiskSpace returns the number of unused 1k blocks available on
// the volume.
func (v *unixVolume) FreeDiskSpace() (free uint64, err error) {
	var fs syscall.Statfs_t
	err = syscall.Statfs(v.Root, &fs)
	if err == nil {
		// Statfs output is not guaranteed to measure free
		// space in terms of 1K blocks.
		free = fs.Bavail * uint64(fs.Bsize)
	}
	return
}

// InternalStats returns I/O and filesystem ops counters.
func (v *unixVolume) InternalStats() interface{} {
	return &v.os.stats
}

// lock acquires the serialize lock, if one is in use. If ctx is done
// before the lock is acquired, lock returns ctx.Err() instead of
// acquiring the lock.
func (v *unixVolume) lock(ctx context.Context) error {
	if v.locker == nil {
		return nil
	}
	t0 := time.Now()
	locked := make(chan struct{})
	go func() {
		v.locker.Lock()
		close(locked)
	}()
	select {
	case <-ctx.Done():
		v.logger.Infof("client hung up while waiting for Serialize lock (%s)", time.Since(t0))
		go func() {
			<-locked
			v.locker.Unlock()
		}()
		return ctx.Err()
	case <-locked:
		return nil
	}
}

// unlock releases the serialize lock, if one is in use.
func (v *unixVolume) unlock() {
	if v.locker == nil {
		return
	}
	v.locker.Unlock()
}

// lockfile and unlockfile use flock(2) to manage kernel file locks.
func (v *unixVolume) lockfile(f *os.File) error {
	v.os.stats.TickOps("flock")
	v.os.stats.Tick(&v.os.stats.FlockOps)
	err := syscall.Flock(int(f.Fd()), syscall.LOCK_EX)
	v.os.stats.TickErr(err)
	return err
}

func (v *unixVolume) unlockfile(f *os.File) error {
	err := syscall.Flock(int(f.Fd()), syscall.LOCK_UN)
	v.os.stats.TickErr(err)
	return err
}

// Where appropriate, translate a more specific filesystem error to an
// error recognized by handlers, like os.ErrNotExist.
func (v *unixVolume) translateError(err error) error {
	switch err.(type) {
	case *os.PathError:
		// stat() returns a PathError if the parent directory
		// (not just the file itself) is missing
		return os.ErrNotExist
	default:
		return err
	}
}

var unixTrashLocRegexp = regexp.MustCompile(`/([0-9a-f]{32})\.trash\.(\d+)$`)

// EmptyTrash walks hierarchy looking for {hash}.trash.*
// and deletes those with deadline < now.
func (v *unixVolume) EmptyTrash() {
	var bytesDeleted, bytesInTrash int64
	var blocksDeleted, blocksInTrash int64

	doFile := func(path string, info os.FileInfo) {
		if info.Mode().IsDir() {
			return
		}
		matches := unixTrashLocRegexp.FindStringSubmatch(path)
		if len(matches) != 3 {
			return
		}
		deadline, err := strconv.ParseInt(matches[2], 10, 64)
		if err != nil {
			v.logger.WithError(err).Errorf("EmptyTrash: %v: ParseInt(%q) failed", path, matches[2])
			return
		}
		atomic.AddInt64(&bytesInTrash, info.Size())
		atomic.AddInt64(&blocksInTrash, 1)
		if deadline > time.Now().Unix() {
			return
		}
		err = v.os.Remove(path)
		if err != nil {
			v.logger.WithError(err).Errorf("EmptyTrash: Remove(%q) failed", path)
			return
		}
		atomic.AddInt64(&bytesDeleted, info.Size())
		atomic.AddInt64(&blocksDeleted, 1)
	}

	type dirent struct {
		path string
		info os.FileInfo
	}
	var wg sync.WaitGroup
	todo := make(chan dirent, v.cluster.Collections.BlobDeleteConcurrency)
	for i := 0; i < v.cluster.Collections.BlobDeleteConcurrency; i++ {
		wg.Add(1)
		go func() {
			defer wg.Done()
			for e := range todo {
				doFile(e.path, e.info)
			}
		}()
	}

	err := filepath.Walk(v.Root, func(path string, info os.FileInfo, err error) error {
		if err != nil {
			v.logger.WithError(err).Errorf("EmptyTrash: filepath.Walk(%q) failed", path)
			// Don't give up -- keep walking other
			// files/dirs
			return nil
		} else if !info.Mode().IsDir() {
			todo <- dirent{path, info}
			return nil
		} else if path == v.Root || blockDirRe.MatchString(info.Name()) {
			// Descend into a directory that we might have
			// put trash in.
			return nil
		} else {
			// Don't descend into other dirs.
			return filepath.SkipDir
		}
	})
	close(todo)
	wg.Wait()

	if err != nil {
		v.logger.WithError(err).Error("EmptyTrash failed")
	}

	v.logger.Infof("EmptyTrash stats: Deleted %v bytes in %v blocks. Remaining in trash: %v bytes in %v blocks.", bytesDeleted, blocksDeleted, bytesInTrash-bytesDeleted, blocksInTrash-blocksDeleted)
}

type unixStats struct {
	statsTicker
	OpenOps    uint64
	StatOps    uint64
	FlockOps   uint64
	UtimesOps  uint64
	CreateOps  uint64
	RenameOps  uint64
	UnlinkOps  uint64
	ReaddirOps uint64
}

func (s *unixStats) TickErr(err error) {
	if err == nil {
		return
	}
	s.statsTicker.TickErr(err, fmt.Sprintf("%T", err))
}

type osWithStats struct {
	stats unixStats
}

func (o *osWithStats) Open(name string) (*os.File, error) {
	o.stats.TickOps("open")
	o.stats.Tick(&o.stats.OpenOps)
	f, err := os.Open(name)
	o.stats.TickErr(err)
	return f, err
}

func (o *osWithStats) OpenFile(name string, flag int, perm os.FileMode) (*os.File, error) {
	o.stats.TickOps("open")
	o.stats.Tick(&o.stats.OpenOps)
	f, err := os.OpenFile(name, flag, perm)
	o.stats.TickErr(err)
	return f, err
}

func (o *osWithStats) Remove(path string) error {
	o.stats.TickOps("unlink")
	o.stats.Tick(&o.stats.UnlinkOps)
	err := os.Remove(path)
	o.stats.TickErr(err)
	return err
}

func (o *osWithStats) Rename(a, b string) error {
	o.stats.TickOps("rename")
	o.stats.Tick(&o.stats.RenameOps)
	err := os.Rename(a, b)
	o.stats.TickErr(err)
	return err
}

func (o *osWithStats) Stat(path string) (os.FileInfo, error) {
	o.stats.TickOps("stat")
	o.stats.Tick(&o.stats.StatOps)
	fi, err := os.Stat(path)
	o.stats.TickErr(err)
	return fi, err
}

func (o *osWithStats) TempFile(dir, base string) (*os.File, error) {
	o.stats.TickOps("create")
	o.stats.Tick(&o.stats.CreateOps)
	f, err := ioutil.TempFile(dir, base)
	o.stats.TickErr(err)
	return f, err
}