local.go

/*
Copyright 2018 Gravitational, Inc.

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 scp

import (
	"io"
	"os"
	"path/filepath"

	"github.com/gravitational/teleport/lib/utils"
	"github.com/gravitational/trace"
)

// localFileSystem provides API for accessing the files on
// the local file system
type localFileSystem struct {
}

// SetChmod sets file permissions
func (l *localFileSystem) SetChmod(path string, mode int) error {
	chmode := os.FileMode(mode & int(os.ModePerm))
	if err := os.Chmod(path, chmode); err != nil {
		return trace.Wrap(err)
	}

	return nil
}

// MkDir creates a directory
func (l *localFileSystem) MkDir(path string, mode int) error {
	fileMode := os.FileMode(mode & int(os.ModePerm))
	err := os.MkdirAll(path, fileMode)
	if err != nil && !os.IsExist(err) {
		return trace.Wrap(err)
	}

	return nil
}

// IsDir tells if a given path is a directory
func (l *localFileSystem) IsDir(path string) bool {
	return utils.IsDir(path)
}

// OpenFile opens a file for read operations and returns a Reader
func (l *localFileSystem) OpenFile(filePath string) (io.ReadCloser, error) {
	f, err := os.Open(filePath)
	if err != nil {
		return nil, trace.Wrap(err)
	}

	return f, nil
}

// GetFileInfo returns FileInfo for a given file path
func (l *localFileSystem) GetFileInfo(filePath string) (FileInfo, error) {
	info, err := makeFileInfo(filePath)
	if err != nil {
		return nil, trace.Wrap(err)
	}

	return info, nil
}

// CreateFile creates a new file and returns a Writer
func (l *localFileSystem) CreateFile(filePath string, length uint64) (io.WriteCloser, error) {
	f, err := os.Create(filePath)
	if err != nil {
		return nil, trace.Wrap(err)
	}

	return f, nil
}

func makeFileInfo(filePath string) (FileInfo, error) {
	f, err := os.Stat(filePath)
	if err != nil {
		return nil, trace.Wrap(err)
	}

	return &localFileInfo{
		filePath: filePath,
		fileInfo: f}, nil
}

// localFileInfo is implementaion of FileInfo for local files
type localFileInfo struct {
	isRecursive bool
	filePath    string
	fileInfo    os.FileInfo
}

// IsDir tells this is a directory
func (l *localFileInfo) IsDir() bool {
	return l.fileInfo.IsDir()
}

// GetName returns file name
func (l *localFileInfo) GetName() string {
	return l.fileInfo.Name()
}

// GetPath returns file path
func (l *localFileInfo) GetPath() string {
	return l.filePath
}

// GetSize returns file size
func (l *localFileInfo) GetSize() int64 {
	return l.fileInfo.Size()
}

// ReadDir returns all files in this directory
func (l *localFileInfo) ReadDir() ([]FileInfo, error) {
	f, err := os.Open(l.filePath)
	if err != nil {
		return nil, trace.Wrap(err)
	}

	fis, err := f.Readdir(0)
	if err != nil {
		return nil, trace.Wrap(err)
	}

	infos := make([]FileInfo, len(fis))
	for i := range fis {
		fi := fis[i]
		info, err := makeFileInfo(filepath.Join(l.GetPath(), fi.Name()))
		if err != nil {
			return nil, trace.Wrap(err)
		}
		infos[i] = info
	}

	return infos, nil
}

// GetModePerm returns file permissions
func (l *localFileInfo) GetModePerm() os.FileMode {
	return l.fileInfo.Mode() & os.ModePerm
}