Task Attachments (#104)

pkg/files/db.go

@@ -0,0 +1,49 @@
+//   Vikunja is a todo-list application to facilitate your life.
+//   Copyright 2019 Vikunja and contributors. All rights reserved.
+//
+//   This program is free software: you can redistribute it and/or modify
+//   it under the terms of the GNU General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   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 General Public License for more details.
+//
+//   You should have received a copy of the GNU General Public License
+//   along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package files
+
+import (
+	"code.vikunja.io/api/pkg/config"
+	"code.vikunja.io/api/pkg/db"
+	"code.vikunja.io/api/pkg/log"
+	"github.com/go-xorm/xorm"
+)
+
+var x *xorm.Engine
+
+// SetEngine sets the xorm.Engine
+func SetEngine() (err error) {
+	x, err = db.CreateDBEngine()
+	if err != nil {
+		log.Criticalf("Could not connect to db: %v", err.Error())
+		return
+	}
+
+	// Cache
+	if config.CacheEnabled.GetBool() && config.CacheType.GetString() == "redis" {
+		db.RegisterTableStructsForCache(GetTables())
+	}
+
+	return nil
+}
+
+// GetTables returns all structs which are also a table.
+func GetTables() []interface{} {
+	return []interface{}{
+		&File{},
+	}
+}

pkg/files/error.go

@@ -0,0 +1,52 @@
+// Copyright 2019 Vikunja and contriubtors. All rights reserved.
+//
+// This file is part of Vikunja.
+//
+// Vikunja is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Vikunja 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 General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Vikunja.  If not, see <https://www.gnu.org/licenses/>.
+
+package files
+
+import "fmt"
+
+// ErrFileDoesNotExist defines an error where a file does not exist in the db
+type ErrFileDoesNotExist struct {
+	FileID int64
+}
+
+// Error is the error implementation of ErrFileDoesNotExist
+func (err ErrFileDoesNotExist) Error() string {
+	return fmt.Sprintf("file %d does not exist", err.FileID)
+}
+
+//IsErrFileDoesNotExist checks if an error is ErrFileDoesNotExist
+func IsErrFileDoesNotExist(err error) bool {
+	_, ok := err.(ErrFileDoesNotExist)
+	return ok
+}
+
+// ErrFileIsTooLarge defines an error where a file is larger than the configured limit
+type ErrFileIsTooLarge struct {
+	Size int64
+}
+
+// Error is the error implementation of ErrFileIsTooLarge
+func (err ErrFileIsTooLarge) Error() string {
+	return fmt.Sprintf("file is too large [Size: %d]", err.Size)
+}
+
+//IsErrFileIsTooLarge checks if an error is ErrFileIsTooLarge
+func IsErrFileIsTooLarge(err error) bool {
+	_, ok := err.(ErrFileIsTooLarge)
+	return ok
+}

pkg/files/filehandling.go

@@ -0,0 +1,97 @@
+//   Vikunja is a todo-list application to facilitate your life.
+//   Copyright 2019 Vikunja and contributors. All rights reserved.
+//
+//   This program is free software: you can redistribute it and/or modify
+//   it under the terms of the GNU General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   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 General Public License for more details.
+//
+//   You should have received a copy of the GNU General Public License
+//   along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package files
+
+import (
+	"code.vikunja.io/api/pkg/config"
+	"code.vikunja.io/api/pkg/db"
+	"code.vikunja.io/api/pkg/log"
+	"github.com/spf13/afero"
+	"github.com/stretchr/testify/assert"
+	"gopkg.in/testfixtures.v2"
+	"os"
+	"path/filepath"
+	"testing"
+)
+
+// This file handles storing and retrieving a file for different backends
+var fs afero.Fs
+var afs *afero.Afero
+
+// InitFileHandler creates a new file handler for the file backend we want to use
+func InitFileHandler() {
+	fs = afero.NewOsFs()
+	afs = &afero.Afero{Fs: fs}
+}
+
+// InitTestFileHandler initializes a new memory file system for testing
+func InitTestFileHandler() {
+	fs = afero.NewMemMapFs()
+	afs = &afero.Afero{Fs: fs}
+}
+
+func initFixtures(t *testing.T) {
+	// Init db fixtures
+	err := db.LoadFixtures()
+	assert.NoError(t, err)
+
+	InitTestFileFixtures(t)
+}
+
+//InitTestFileFixtures initializes file fixtures
+func InitTestFileFixtures(t *testing.T) {
+	// Init fixture files
+	filename := config.FilesBasePath.GetString() + "/1"
+	err := afero.WriteFile(afs, filename, []byte("testfile1"), 0644)
+	assert.NoError(t, err)
+}
+
+// InitTests handles the actual bootstrapping of the test env
+func InitTests() {
+	var err error
+	x, err = db.CreateTestEngine()
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	err = x.Sync2(GetTables()...)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	config.InitDefaultConfig()
+	// We need to set the root path even if we're not using the config, otherwise fixtures are not loaded correctly
+	config.ServiceRootpath.Set(os.Getenv("VIKUNJA_SERVICE_ROOTPATH"))
+
+	// Sync fixtures
+	var fixturesHelper testfixtures.Helper = &testfixtures.SQLite{}
+	if config.DatabaseType.GetString() == "mysql" {
+		fixturesHelper = &testfixtures.MySQL{}
+	}
+	fixturesDir := filepath.Join(config.ServiceRootpath.GetString(), "pkg", "files", "fixtures")
+	err = db.InitFixtures(fixturesHelper, fixturesDir)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	InitTestFileHandler()
+}
+
+// FileStat stats a file. This is an exported function to be able to test this from outide of the package
+func FileStat(filename string) (os.FileInfo, error) {
+	return afs.Stat(filename)
+}

pkg/files/files.go

@@ -0,0 +1,104 @@
+//   Vikunja is a todo-list application to facilitate your life.
+//   Copyright 2019 Vikunja and contributors. All rights reserved.
+//
+//   This program is free software: you can redistribute it and/or modify
+//   it under the terms of the GNU General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   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 General Public License for more details.
+//
+//   You should have received a copy of the GNU General Public License
+//   along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package files
+
+import (
+	"code.vikunja.io/api/pkg/config"
+	"code.vikunja.io/web"
+	"github.com/spf13/afero"
+	"io"
+	"strconv"
+	"time"
+)
+
+// File holds all information about a file
+type File struct {
+	ID   int64  `xorm:"int(11) autoincr not null unique pk" json:"id"`
+	Name string `xorm:"text not null" json:"name"`
+	Mime string `xorm:"text null" json:"mime"`
+	Size int64  `xorm:"int(11) not null" json:"size"`
+
+	Created time.Time `xorm:"-" json:"created"`
+
+	CreatedUnix int64 `xorm:"created" json:"-"`
+	CreatedByID int64 `xorm:"int(11) not null" json:"-"`
+
+	File afero.File `xorm:"-" json:"-"`
+}
+
+// TableName is the table name for the files table
+func (File) TableName() string {
+	return "files"
+}
+
+func (f *File) getFileName() string {
+	return config.FilesBasePath.GetString() + "/" + strconv.FormatInt(f.ID, 10)
+}
+
+// LoadFileByID returns a file by its ID
+func (f *File) LoadFileByID() (err error) {
+	f.File, err = afs.Open(f.getFileName())
+	return
+}
+
+// LoadFileMetaByID loads everything about a file without loading the actual file
+func (f *File) LoadFileMetaByID() (err error) {
+	exists, err := x.Where("id = ?", f.ID).Get(f)
+	if !exists {
+		return ErrFileDoesNotExist{FileID: f.ID}
+	}
+	f.Created = time.Unix(f.CreatedUnix, 0)
+	return
+}
+
+// Create creates a new file from an FileHeader
+func Create(f io.ReadCloser, realname string, realsize int64, a web.Auth) (file *File, err error) {
+
+	if realsize > config.FilesMaxSize.GetInt64() {
+		return nil, ErrFileIsTooLarge{Size: realsize}
+	}
+
+	// We first insert the file into the db to get it's ID
+	file = &File{
+		Name:        realname,
+		Size:        realsize,
+		CreatedByID: a.GetID(),
+	}
+
+	_, err = x.Insert(file)
+	if err != nil {
+		return
+	}
+
+	// Save the file to storage with its new ID as path
+	err = afs.WriteReader(file.getFileName(), f)
+	return
+}
+
+// Delete removes a file from the DB and the file system
+func (f *File) Delete() (err error) {
+	deleted, err := x.Where("id = ?", f.ID).Delete(f)
+	if err != nil {
+		return err
+	}
+	if deleted == 0 {
+		return ErrFileDoesNotExist{FileID: f.ID}
+	}
+
+	err = afs.Remove(f.getFileName())
+	return
+}

pkg/files/files_test.go

@@ -0,0 +1,131 @@
+// Copyright 2019 Vikunja and contriubtors. All rights reserved.
+//
+// This file is part of Vikunja.
+//
+// Vikunja is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Vikunja 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 General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Vikunja.  If not, see <https://www.gnu.org/licenses/>.
+
+package files
+
+import (
+	"github.com/stretchr/testify/assert"
+	"io"
+	"os"
+	"testing"
+)
+
+type testfile struct {
+	content []byte
+	done    bool
+}
+
+func (t *testfile) Read(p []byte) (n int, err error) {
+	if t.done {
+		return 0, io.EOF
+	}
+	copy(p, t.content)
+	t.done = true
+	return len(p), nil
+}
+
+func (t *testfile) Close() error {
+	return nil
+}
+
+type testauth struct {
+	id int64
+}
+
+func (a *testauth) GetID() int64 {
+	return a.id
+}
+
+func TestCreate(t *testing.T) {
+	t.Run("Normal", func(t *testing.T) {
+		initFixtures(t)
+		tf := &testfile{
+			content: []byte("testfile"),
+		}
+		ta := &testauth{id: 1}
+		_, err := Create(tf, "testfile", 100, ta)
+		assert.NoError(t, err)
+
+		// Check the file was created correctly
+		file := &File{ID: 2}
+		err = file.LoadFileMetaByID()
+		assert.NoError(t, err)
+		assert.Equal(t, int64(1), file.CreatedByID)
+		assert.Equal(t, "testfile", file.Name)
+		assert.Equal(t, int64(100), file.Size)
+
+	})
+	t.Run("Too Large", func(t *testing.T) {
+		initFixtures(t)
+		tf := &testfile{
+			content: []byte("testfile"),
+		}
+		ta := &testauth{id: 1}
+		_, err := Create(tf, "testfile", 99999999999, ta)
+		assert.Error(t, err)
+		assert.True(t, IsErrFileIsTooLarge(err))
+	})
+}
+
+func TestFile_Delete(t *testing.T) {
+	t.Run("Normal", func(t *testing.T) {
+		initFixtures(t)
+		f := &File{ID: 1}
+		err := f.Delete()
+		assert.NoError(t, err)
+	})
+	t.Run("Nonexisting", func(t *testing.T) {
+		initFixtures(t)
+		f := &File{ID: 9999}
+		err := f.Delete()
+		assert.Error(t, err)
+		assert.True(t, IsErrFileDoesNotExist(err))
+	})
+}
+
+func TestFile_LoadFileByID(t *testing.T) {
+	t.Run("Normal", func(t *testing.T) {
+		initFixtures(t)
+		f := &File{ID: 1}
+		err := f.LoadFileByID()
+		assert.NoError(t, err)
+	})
+	t.Run("Nonexisting", func(t *testing.T) {
+		initFixtures(t)
+		f := &File{ID: 9999}
+		err := f.LoadFileByID()
+		assert.Error(t, err)
+		assert.True(t, os.IsNotExist(err))
+	})
+}
+
+func TestFile_LoadFileMetaByID(t *testing.T) {
+	t.Run("Normal", func(t *testing.T) {
+		initFixtures(t)
+		f := &File{ID: 1}
+		err := f.LoadFileMetaByID()
+		assert.NoError(t, err)
+		assert.Equal(t, "test", f.Name)
+	})
+	t.Run("Nonexisting", func(t *testing.T) {
+		initFixtures(t)
+		f := &File{ID: 9999}
+		err := f.LoadFileMetaByID()
+		assert.Error(t, err)
+		assert.True(t, IsErrFileDoesNotExist(err))
+	})
+}

pkg/files/fixtures/files.yml

@@ -0,0 +1,5 @@
+- id: 1
+  name: test
+  size: 100
+  created_unix: 1570998791
+  created_by_id: 1

pkg/files/main_test.go

@@ -0,0 +1,29 @@
+// Copyright 2019 Vikunja and contriubtors. All rights reserved.
+//
+// This file is part of Vikunja.
+//
+// Vikunja is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Vikunja 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 General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Vikunja.  If not, see <https://www.gnu.org/licenses/>.
+
+package files
+
+import (
+	"os"
+	"testing"
+)
+
+// TestMain is the main test function used to bootstrap the test env
+func TestMain(m *testing.M) {
+	InitTests()
+	os.Exit(m.Run())
+}