first-commit

modules/system/appstate.go

@@ -0,0 +1,26 @@
+// Copyright 2021 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package system
+
+import "context"
+
+// StateStore is the interface to get/set app state items
+type StateStore interface {
+	Get(ctx context.Context, item StateItem) error
+	Set(ctx context.Context, item StateItem) error
+}
+
+// StateItem provides the name for a state item. the name will be used to generate filenames, etc
+type StateItem interface {
+	Name() string
+}
+
+// AppState contains the state items for the app
+var AppState StateStore
+
+// Init initialize AppState interface
+func Init() error {
+	AppState = &DBStore{}
+	return nil
+}

modules/system/appstate_test.go

@@ -0,0 +1,61 @@
+// Copyright 2021 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package system
+
+import (
+	"testing"
+
+	"code.gitea.io/gitea/models/db"
+	"code.gitea.io/gitea/models/unittest"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestMain(m *testing.M) {
+	unittest.MainTest(m, &unittest.TestOptions{FixtureFiles: []string{ /* load nothing */ }})
+}
+
+type testItem1 struct {
+	Val1 string
+	Val2 int
+}
+
+func (*testItem1) Name() string {
+	return "test-item1"
+}
+
+type testItem2 struct {
+	K string
+}
+
+func (*testItem2) Name() string {
+	return "test-item2"
+}
+
+func TestAppStateDB(t *testing.T) {
+	as := &DBStore{}
+
+	item1 := new(testItem1)
+	assert.NoError(t, as.Get(db.DefaultContext, item1))
+	assert.Empty(t, item1.Val1)
+	assert.Equal(t, 0, item1.Val2)
+
+	item1 = new(testItem1)
+	item1.Val1 = "a"
+	item1.Val2 = 2
+	assert.NoError(t, as.Set(db.DefaultContext, item1))
+
+	item2 := new(testItem2)
+	item2.K = "V"
+	assert.NoError(t, as.Set(db.DefaultContext, item2))
+
+	item1 = new(testItem1)
+	assert.NoError(t, as.Get(db.DefaultContext, item1))
+	assert.Equal(t, "a", item1.Val1)
+	assert.Equal(t, 2, item1.Val2)
+
+	item2 = new(testItem2)
+	assert.NoError(t, as.Get(db.DefaultContext, item2))
+	assert.Equal(t, "V", item2.K)
+}

modules/system/db.go

@@ -0,0 +1,36 @@
+// Copyright 2021 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package system
+
+import (
+	"context"
+
+	"code.gitea.io/gitea/models/system"
+	"code.gitea.io/gitea/modules/json"
+	"code.gitea.io/gitea/modules/util"
+)
+
+// DBStore can be used to store app state items in local filesystem
+type DBStore struct{}
+
+// Get reads the state item
+func (f *DBStore) Get(ctx context.Context, item StateItem) error {
+	content, err := system.GetAppStateContent(ctx, item.Name())
+	if err != nil {
+		return err
+	}
+	if content == "" {
+		return nil
+	}
+	return json.Unmarshal(util.UnsafeStringToBytes(content), item)
+}
+
+// Set saves the state item
+func (f *DBStore) Set(ctx context.Context, item StateItem) error {
+	b, err := json.Marshal(item)
+	if err != nil {
+		return err
+	}
+	return system.SaveAppStateContent(ctx, item.Name(), util.UnsafeBytesToString(b))
+}

modules/system/item_runtime.go

@@ -0,0 +1,15 @@
+// Copyright 2021 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package system
+
+// RuntimeState contains app state for runtime, and we can save remote version for update checker here in future
+type RuntimeState struct {
+	LastAppPath    string `json:"last_app_path"`
+	LastCustomConf string `json:"last_custom_conf"`
+}
+
+// Name returns the item name
+func (a RuntimeState) Name() string {
+	return "runtime-state"
+}