summaryrefslogtreecommitdiff
path: root/internal/config/global.go
diff options
context:
space:
mode:
authorLibravatar kim <89579420+NyaaaWhatsUpDoc@users.noreply.github.com>2022-05-30 13:41:24 +0100
committerLibravatar GitHub <noreply@github.com>2022-05-30 14:41:24 +0200
commit43ac0cdb9c4eea9d3c5eceb2c11b9e5b98b87b00 (patch)
treef0d5967d0ce639b6bc82aaf607f62e228fdf4559 /internal/config/global.go
parent[chore] Mastodon api fixups (#617) (diff)
downloadgotosocial-43ac0cdb9c4eea9d3c5eceb2c11b9e5b98b87b00.tar.xz
[chore] Global server configuration overhaul (#575)
* move config flag names and usage to config package, rewrite config package to use global Configuration{} struct Signed-off-by: kim <grufwub@gmail.com> * improved code comment Signed-off-by: kim <grufwub@gmail.com> * linter Signed-off-by: kim <grufwub@gmail.com> * fix unmarshaling Signed-off-by: kim <grufwub@gmail.com> * remove kim's custom go compiler changes Signed-off-by: kim <grufwub@gmail.com> * generate setter and flag-name functions, implement these in codebase Signed-off-by: kim <grufwub@gmail.com> * update deps Signed-off-by: kim <grufwub@gmail.com> * small change Signed-off-by: kim <grufwub@gmail.com> * appease the linter... Signed-off-by: kim <grufwub@gmail.com> * move configuration into ConfigState structure, ensure reloading to/from viper settings to keep in sync Signed-off-by: kim <grufwub@gmail.com> * lint Signed-off-by: kim <grufwub@gmail.com> * update code comments Signed-off-by: kim <grufwub@gmail.com> * fix merge issue Signed-off-by: kim <grufwub@gmail.com> * fix merge issue Signed-off-by: kim <grufwub@gmail.com> * improved version string (removes time + go version) Signed-off-by: kim <grufwub@gmail.com> * fix version string build to pass test script + consolidate logic in func Signed-off-by: kim <grufwub@gmail.com> * add license text, update config.Defaults comment Signed-off-by: kim <grufwub@gmail.com> * add license text to generated config helpers file Signed-off-by: kim <grufwub@gmail.com> * defer unlock on config.Set___(), to ensure unlocked on panic Signed-off-by: kim <grufwub@gmail.com> * make it more obvious which cmd flags are being attached Signed-off-by: kim <grufwub@gmail.com>
Diffstat (limited to 'internal/config/global.go')
-rw-r--r--internal/config/global.go53
1 files changed, 53 insertions, 0 deletions
diff --git a/internal/config/global.go b/internal/config/global.go
new file mode 100644
index 000000000..8752fc925
--- /dev/null
+++ b/internal/config/global.go
@@ -0,0 +1,53 @@
+/*
+ GoToSocial
+ Copyright (C) 2021-2022 GoToSocial Authors admin@gotosocial.org
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+package config
+
+import "github.com/spf13/cobra"
+
+var global *ConfigState
+
+func init() {
+ // init global state
+ global = NewState()
+}
+
+// TODO: in the future we should move away from using globals in this config
+// package, and instead pass the ConfigState round in a global gts state.
+
+// Config provides you safe access to the global configuration.
+func Config(fn func(cfg *Configuration)) {
+ global.Config(fn)
+}
+
+// Reload will reload the current configuration values from file.
+func Reload() error {
+ return global.Reload()
+}
+
+// LoadEarlyFlags will bind specific flags from given Cobra command to global viper
+// instance, and load the current configuration values. This is useful for flags like
+// .ConfigPath which have to parsed first in order to perform early configuration load.
+func LoadEarlyFlags(cmd *cobra.Command) error {
+ return global.LoadEarlyFlags(cmd)
+}
+
+// BindFlags binds given command's pflags to the global viper instance.
+func BindFlags(cmd *cobra.Command) error {
+ return global.BindFlags(cmd)
+}