ceph-csi/internal/util/nodecache.go

/*
Copyright 2018 The Ceph-CSI Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package util

import (
	"encoding/json"
	"errors"
	"fmt"
	"io/ioutil"
	"os"
	"path"
	"path/filepath"
	"regexp"
	"strings"

	klog "k8s.io/klog/v2"
)

// NodeCache to store metadata
type NodeCache struct {
	BasePath string
	CacheDir string
}

var errDec = errors.New("file not found")

// EnsureCacheDirectory creates cache directory if not present
func (nc *NodeCache) EnsureCacheDirectory(cacheDir string) error {
	fullPath := path.Join(nc.BasePath, cacheDir)
	if _, err := os.Stat(fullPath); os.IsNotExist(err) {
		// #nosec
		if err := os.Mkdir(fullPath, 0755); err != nil {
			return fmt.Errorf("node-cache: failed to create %s folder: %w", fullPath, err)
		}
	}
	return nil
}

// ForAll list the metadata in Nodecache and filters outs based on the pattern
func (nc *NodeCache) ForAll(pattern string, destObj interface{}, f ForAllFunc) error {
	err := nc.EnsureCacheDirectory(nc.CacheDir)
	if err != nil {
		return fmt.Errorf("node-cache: couldn't ensure cache directory exists: %w", err)
	}
	files, err := ioutil.ReadDir(path.Join(nc.BasePath, nc.CacheDir))
	if err != nil {
		return fmt.Errorf("node-cache: failed to read %s folder: %w", nc.BasePath, err)
	}
	cachePath := path.Join(nc.BasePath, nc.CacheDir)
	for _, file := range files {
		err = decodeObj(cachePath, pattern, file, destObj)
		if errors.Is(err, errDec) {
			continue
		} else if err == nil {
			if err = f(strings.TrimSuffix(file.Name(), filepath.Ext(file.Name()))); err != nil {
				return err
			}
		}
		return err
	}
	return nil
}

func decodeObj(fpath, pattern string, file os.FileInfo, destObj interface{}) error {
	match, err := regexp.MatchString(pattern, file.Name())
	if err != nil || !match {
		return errDec
	}
	if !strings.HasSuffix(file.Name(), ".json") {
		return errDec
	}
	// #nosec
	fp, err := os.Open(path.Join(fpath, file.Name()))
	if err != nil {
		DebugLogMsg("node-cache: open file: %s err %v", file.Name(), err)
		return errDec
	}
	decoder := json.NewDecoder(fp)
	if err = decoder.Decode(destObj); err != nil {
		if err = fp.Close(); err != nil {
			return fmt.Errorf("failed to close file %s: %w", file.Name(), err)
		}
		return fmt.Errorf("node-cache: couldn't decode file %s: %w", file.Name(), err)
	}
	return nil
}

// Create creates the metadata file in cache directory with identifier name
func (nc *NodeCache) Create(identifier string, data interface{}) error {
	file := path.Join(nc.BasePath, nc.CacheDir, identifier+".json")
	fp, err := os.Create(file)
	if err != nil {
		return fmt.Errorf("node-cache: failed to create metadata storage file %s: %w", file, err)
	}

	defer func() {
		if err = fp.Close(); err != nil {
			klog.Warningf("failed to close file:%s %v", fp.Name(), err)
		}
	}()

	encoder := json.NewEncoder(fp)
	if err = encoder.Encode(data); err != nil {
		return fmt.Errorf("node-cache: failed to encode metadata for file: %s: %w", file, err)
	}
	DebugLogMsg("node-cache: successfully saved metadata into file: %s\n", file)
	return nil
}

// Get retrieves the metadata from cache directory with identifier name
func (nc *NodeCache) Get(identifier string, data interface{}) error {
	file := path.Join(nc.BasePath, nc.CacheDir, identifier+".json")
	// #nosec
	fp, err := os.Open(file)
	if err != nil {
		if errors.Is(err, os.ErrNotExist) {
			return &CacheEntryNotFound{err}
		}

		return fmt.Errorf("node-cache: open error for %s: %w", file, err)
	}

	defer func() {
		if err = fp.Close(); err != nil {
			klog.Warningf("failed to close file:%s %v", fp.Name(), err)
		}
	}()

	decoder := json.NewDecoder(fp)
	if err = decoder.Decode(data); err != nil {
		return fmt.Errorf("rbd: decode error: %w", err)
	}

	return nil
}

// Delete deletes the metadata file from cache directory with identifier name
func (nc *NodeCache) Delete(identifier string) error {
	file := path.Join(nc.BasePath, nc.CacheDir, identifier+".json")
	err := os.Remove(file)
	if err != nil {
		if os.IsNotExist(err) {
			DebugLogMsg("node-cache: cannot delete missing metadata storage file %s, assuming it's already deleted", file)
			return nil
		}

		return fmt.Errorf("node-cache: error removing file %s: %w", file, err)
	}
	DebugLogMsg("node-cache: successfully deleted metadata storage file at: %+v\n", file)
	return nil
}