summaryrefslogtreecommitdiffstats
path: root/modules/system
diff options
context:
space:
mode:
authorDaniel Baumann <daniel@debian.org>2024-10-18 20:33:49 +0200
committerDaniel Baumann <daniel@debian.org>2024-10-18 20:33:49 +0200
commitdd136858f1ea40ad3c94191d647487fa4f31926c (patch)
tree58fec94a7b2a12510c9664b21793f1ed560c6518 /modules/system
parentInitial commit. (diff)
downloadforgejo-upstream/9.0.0.tar.xz
forgejo-upstream/9.0.0.zip
Adding upstream version 9.0.0.HEADupstream/9.0.0upstreamdebian
Signed-off-by: Daniel Baumann <daniel@debian.org>
Diffstat (limited to 'modules/system')
-rw-r--r--modules/system/appstate.go26
-rw-r--r--modules/system/appstate_test.go66
-rw-r--r--modules/system/db.go36
-rw-r--r--modules/system/item_runtime.go15
4 files changed, 143 insertions, 0 deletions
diff --git a/modules/system/appstate.go b/modules/system/appstate.go
new file mode 100644
index 0000000..e065688
--- /dev/null
+++ b/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
+}
diff --git a/modules/system/appstate_test.go b/modules/system/appstate_test.go
new file mode 100644
index 0000000..2f44c7b
--- /dev/null
+++ b/modules/system/appstate_test.go
@@ -0,0 +1,66 @@
+// 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"
+ "github.com/stretchr/testify/require"
+)
+
+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) {
+ require.NoError(t, unittest.PrepareTestDatabase())
+
+ as := &DBStore{}
+
+ item1 := new(testItem1)
+ require.NoError(t, as.Get(db.DefaultContext, item1))
+ assert.Equal(t, "", item1.Val1)
+ assert.EqualValues(t, 0, item1.Val2)
+
+ item1 = new(testItem1)
+ item1.Val1 = "a"
+ item1.Val2 = 2
+ require.NoError(t, as.Set(db.DefaultContext, item1))
+
+ item2 := new(testItem2)
+ item2.K = "V"
+ require.NoError(t, as.Set(db.DefaultContext, item2))
+
+ item1 = new(testItem1)
+ require.NoError(t, as.Get(db.DefaultContext, item1))
+ assert.Equal(t, "a", item1.Val1)
+ assert.EqualValues(t, 2, item1.Val2)
+
+ item2 = new(testItem2)
+ require.NoError(t, as.Get(db.DefaultContext, item2))
+ assert.Equal(t, "V", item2.K)
+}
diff --git a/modules/system/db.go b/modules/system/db.go
new file mode 100644
index 0000000..1717828
--- /dev/null
+++ b/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))
+}
diff --git a/modules/system/item_runtime.go b/modules/system/item_runtime.go
new file mode 100644
index 0000000..ded52c1
--- /dev/null
+++ 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"
+}