// Copyright 2020 The Gitea Authors. All rights reserved.// SPDX-License-Identifier: MIT package storage import ( "context" "fmt" "io" "net/url" "os" "path/filepath" "forgejo.org/modules/log" "forgejo.org/modules/setting" "forgejo.org/modules/util") var _ ObjectStorage = &LocalStorage{} // LocalStorage represents a local files storagetype LocalStorage struct { ctx context.Context dir string tmpdir string} // NewLocalStorage returns a local filesfunc NewLocalStorage(ctx context.Context, config *setting.Storage) (ObjectStorage, error) { if !filepath.IsAbs(config.Path) { return nil, fmt.Errorf("LocalStorageConfig.Path should have been prepared by setting/storage.go and should be an absolute path, but not: %q", config.Path) } log.Info("Creating new Local Storage at %s", config.Path) if err := os.MkdirAll(config.Path, os.ModePerm); err != nil { return nil, err } if config.TemporaryPath == "" { config.TemporaryPath = filepath.Join(config.Path, "tmp") } if !filepath.IsAbs(config.TemporaryPath) { return nil, fmt.Errorf("LocalStorageConfig.TemporaryPath should be an absolute path, but not: %q", config.TemporaryPath) } return &LocalStorage{ ctx: ctx, dir: config.Path, tmpdir: config.TemporaryPath, }, nil} func (l *LocalStorage) buildLocalPath(p string) string { return util.FilePathJoinAbs(l.dir, p)} // Open a filefunc (l *LocalStorage) Open(path string) (Object, error) { return os.Open(l.buildLocalPath(path))} // Save a filefunc (l *LocalStorage) Save(path string, r io.Reader, size int64) (int64, error) { p := l.buildLocalPath(path) if err := os.MkdirAll(filepath.Dir(p), os.ModePerm); err != nil { return 0, err } // Create a temporary file to save to if err := os.MkdirAll(l.tmpdir, os.ModePerm); err != nil { return 0, err } tmp, err := os.CreateTemp(l.tmpdir, "upload-*") if err != nil { return 0, err } tmpRemoved := false defer func() { if !tmpRemoved { _ = util.Remove(tmp.Name()) } }() n, err := io.Copy(tmp, r) if err != nil { return 0, err } if err := tmp.Close(); err != nil { return 0, err } if err := util.Rename(tmp.Name(), p); err != nil { return 0, err } // Golang's tmp file (os.CreateTemp) always have 0o600 mode, so we need to change the file to follow the umask (as what Create/MkDir does) // but we don't want to make these files executable - so ensure that we mask out the executable bits if err := util.ApplyUmask(p, os.ModePerm&0o666); err != nil { return 0, err } tmpRemoved = true return n, nil} // Stat returns the info of the filefunc (l *LocalStorage) Stat(path string) (os.FileInfo, error) { return os.Stat(l.buildLocalPath(path))} // Delete delete a filefunc (l *LocalStorage) Delete(path string) error { return util.Remove(l.buildLocalPath(path))} // URL gets the redirect URL to a filefunc (l *LocalStorage) URL(path, name string, reqParams url.Values) (*url.URL, error) { return nil, ErrURLNotSupported} // IterateObjects iterates across the objects in the local storagefunc (l *LocalStorage) IterateObjects(dirName string, fn func(path string, obj Object) error) error { dir := l.buildLocalPath(dirName) return filepath.WalkDir(dir, func(path string, d os.DirEntry, err error) error { if err != nil { return err } select { case <-l.ctx.Done(): return l.ctx.Err() default: } if path == l.dir { return nil } if d.IsDir() { return nil } relPath, err := filepath.Rel(l.dir, path) if err != nil { return err } obj, err := os.Open(path) if err != nil { return err } defer obj.Close() return fn(relPath, obj) })} func init() { RegisterStorageType(setting.LocalStorageType, NewLocalStorage)}
// Copyright 2020 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package storage
import (
"context"
"fmt"
"io"
"net/url"
"os"
"path/filepath"
"forgejo.org/modules/log"
"forgejo.org/modules/setting"
"forgejo.org/modules/util"
)
var _ ObjectStorage = &LocalStorage{}
// LocalStorage represents a local files storage
type LocalStorage struct {
ctx context.Context
dir string
tmpdir string
}
// NewLocalStorage returns a local files
func NewLocalStorage(ctx context.Context, config *setting.Storage) (ObjectStorage, error) {
if !filepath.IsAbs(config.Path) {
return nil, fmt.Errorf("LocalStorageConfig.Path should have been prepared by setting/storage.go and should be an absolute path, but not: %q", config.Path)
}
log.Info("Creating new Local Storage at %s", config.Path)
if err := os.MkdirAll(config.Path, os.ModePerm); err != nil {
return nil, err
}
if config.TemporaryPath == "" {
config.TemporaryPath = filepath.Join(config.Path, "tmp")
}
if !filepath.IsAbs(config.TemporaryPath) {
return nil, fmt.Errorf("LocalStorageConfig.TemporaryPath should be an absolute path, but not: %q", config.TemporaryPath)
}
return &LocalStorage{
ctx: ctx,
dir: config.Path,
tmpdir: config.TemporaryPath,
}, nil
}
func (l *LocalStorage) buildLocalPath(p string) string {
return util.FilePathJoinAbs(l.dir, p)
}
// Open a file
func (l *LocalStorage) Open(path string) (Object, error) {
return os.Open(l.buildLocalPath(path))
}
// Save a file
func (l *LocalStorage) Save(path string, r io.Reader, size int64) (int64, error) {
p := l.buildLocalPath(path)
if err := os.MkdirAll(filepath.Dir(p), os.ModePerm); err != nil {
return 0, err
}
// Create a temporary file to save to
if err := os.MkdirAll(l.tmpdir, os.ModePerm); err != nil {
return 0, err
}
tmp, err := os.CreateTemp(l.tmpdir, "upload-*")
if err != nil {
return 0, err
}
tmpRemoved := false
defer func() {
if !tmpRemoved {
_ = util.Remove(tmp.Name())
}
}()
n, err := io.Copy(tmp, r)
if err != nil {
return 0, err
}
if err := tmp.Close(); err != nil {
return 0, err
}
if err := util.Rename(tmp.Name(), p); err != nil {
return 0, err
}
// Golang's tmp file (os.CreateTemp) always have 0o600 mode, so we need to change the file to follow the umask (as what Create/MkDir does)
// but we don't want to make these files executable - so ensure that we mask out the executable bits
if err := util.ApplyUmask(p, os.ModePerm&0o666); err != nil {
return 0, err
}
tmpRemoved = true
return n, nil
}
// Stat returns the info of the file
func (l *LocalStorage) Stat(path string) (os.FileInfo, error) {
return os.Stat(l.buildLocalPath(path))
}
// Delete delete a file
func (l *LocalStorage) Delete(path string) error {
return util.Remove(l.buildLocalPath(path))
}
// URL gets the redirect URL to a file
func (l *LocalStorage) URL(path, name string, reqParams url.Values) (*url.URL, error) {
return nil, ErrURLNotSupported
}
// IterateObjects iterates across the objects in the local storage
func (l *LocalStorage) IterateObjects(dirName string, fn func(path string, obj Object) error) error {
dir := l.buildLocalPath(dirName)
return filepath.WalkDir(dir, func(path string, d os.DirEntry, err error) error {
if err != nil {
return err
}
select {
case <-l.ctx.Done():
return l.ctx.Err()
default:
}
if path == l.dir {
return nil
}
if d.IsDir() {
return nil
}
relPath, err := filepath.Rel(l.dir, path)
if err != nil {
return err
}
obj, err := os.Open(path)
if err != nil {
return err
}
defer obj.Close()
return fn(relPath, obj)
})
}
func init() {
RegisterStorageType(setting.LocalStorageType, NewLocalStorage)
}