rename folder extensions -> services

Signed-off-by: Christian Richter <crichter@owncloud.com>
2022-06-27 14:05:36 +02:00
parent 1aea93d8cd
commit 78064e6bab
926 changed files with 0 additions and 0 deletions
@@ -0,0 +1,79 @@
+package config
+
+import (
+	"context"
+
+	"github.com/owncloud/ocis/v2/ocis-pkg/shared"
+)
+
+// Config combines all available configuration parts.
+type Config struct {
+	Commons *shared.Commons `yaml:"-"` // don't use this directly as configuration for a service
+
+	Service Service `yaml:"-"`
+
+	Tracing *Tracing `yaml:"tracing"`
+	Log     *Log     `yaml:"log"`
+	Debug   Debug    `yaml:"debug"`
+
+	HTTP HTTP `yaml:"http"`
+
+	Asset Asset  `yaml:"asset"`
+	File  string `yaml:"file" env:"WEB_UI_CONFIG"` // TODO: rename this to a more self explaining string
+	Web   Web    `yaml:"web"`
+
+	Context context.Context `yaml:"-"`
+}
+
+// Asset defines the available asset configuration.
+type Asset struct {
+	Path string `yaml:"path" env:"WEB_ASSET_PATH"`
+}
+
+// WebConfig defines the available web configuration for a dynamically rendered config.json.
+type WebConfig struct {
+	Server        string                 `json:"server,omitempty" yaml:"server" env:"OCIS_URL;WEB_UI_CONFIG_SERVER"`
+	Theme         string                 `json:"theme,omitempty" yaml:"theme" env:""`
+	Version       string                 `json:"version,omitempty" yaml:"version" env:"WEB_UI_CONFIG_VERSION"`
+	OpenIDConnect OIDC                   `json:"openIdConnect,omitempty" yaml:"oids"`
+	Apps          []string               `json:"apps" yaml:"apps"`
+	ExternalApps  []ExternalApp          `json:"external_apps,omitempty" yaml:"external_apps"`
+	Options       map[string]interface{} `json:"options,omitempty" yaml:"options"`
+}
+
+// OIDC defines the available oidc configuration
+type OIDC struct {
+	MetadataURL  string `json:"metadata_url,omitempty" yaml:"metadata_url" env:"WEB_OIDC_METADATA_URL"`
+	Authority    string `json:"authority,omitempty" yaml:"authority" env:"OCIS_URL;OCIS_OIDC_ISSUER;WEB_OIDC_AUTHORITY" desc:"URL of the OIDC issuer. It defaults to URL of the builtin IDP."`
+	ClientID     string `json:"client_id,omitempty" yaml:"client_id" env:"WEB_OIDC_CLIENT_ID"`
+	ResponseType string `json:"response_type,omitempty" yaml:"response_type" env:"WEB_OIDC_RESPONSE_TYPE"`
+	Scope        string `json:"scope,omitempty" yaml:"scope" env:"WEB_OIDC_SCOPE"`
+}
+
+// ExternalApp defines an external web app.
+// {
+//	"name": "hello",
+//	"path": "http://localhost:9105/hello.js",
+//	  "config": {
+//	    "url": "http://localhost:9105"
+//	  }
+//  }
+type ExternalApp struct {
+	ID   string `json:"id,omitempty" yaml:"id"`
+	Path string `json:"path,omitempty" yaml:"path"`
+	// Config is completely dynamic, because it depends on the extension
+	Config map[string]interface{} `json:"config,omitempty" yaml:"config"`
+}
+
+// ExternalAppConfig defines an external web app configuration.
+type ExternalAppConfig struct {
+	URL string `json:"url,omitempty" yaml:"url" env:""`
+}
+
+// Web defines the available web configuration.
+type Web struct {
+	Path        string    `yaml:"path" env:"WEB_UI_PATH"`
+	ThemeServer string    `yaml:"theme_server" env:"OCIS_URL;WEB_UI_THEME_SERVER"` // used to build Theme in WebConfig
+	ThemePath   string    `yaml:"theme_path" env:"WEB_UI_THEME_PATH"`              // used to build Theme in WebConfig
+	Config      WebConfig `yaml:"config"`
+}
@@ -0,0 +1,9 @@
+package config
+
+// Debug defines the available debug configuration.
+type Debug struct {
+	Addr   string `yaml:"addr" env:"WEB_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."`
+	Token  string `yaml:"token" env:"WEB_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"`
+	Pprof  bool   `yaml:"pprof" env:"WEB_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"`
+	Zpages bool   `yaml:"zpages" env:"WEB_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing in-memory traces."`
+}
@@ -0,0 +1,94 @@
+package defaults
+
+import (
+	"strings"
+
+	"github.com/owncloud/ocis/v2/extensions/web/pkg/config"
+)
+
+func FullDefaultConfig() *config.Config {
+	cfg := DefaultConfig()
+	EnsureDefaults(cfg)
+	Sanitize(cfg)
+	return cfg
+}
+
+func DefaultConfig() *config.Config {
+	return &config.Config{
+		Debug: config.Debug{
+			Addr:   "127.0.0.1:9104",
+			Token:  "",
+			Pprof:  false,
+			Zpages: false,
+		},
+		HTTP: config.HTTP{
+			Addr:      "127.0.0.1:9100",
+			Root:      "/",
+			Namespace: "com.owncloud.web",
+			CacheTTL:  604800, // 7 days
+		},
+		Service: config.Service{
+			Name: "web",
+		},
+		Asset: config.Asset{
+			Path: "",
+		},
+		Web: config.Web{
+			Path:        "",
+			ThemeServer: "https://localhost:9200",
+			ThemePath:   "/themes/owncloud/theme.json",
+			Config: config.WebConfig{
+				Server:  "https://localhost:9200",
+				Theme:   "",
+				Version: "0.1.0",
+				OpenIDConnect: config.OIDC{
+					MetadataURL:  "",
+					Authority:    "https://localhost:9200",
+					ClientID:     "web",
+					ResponseType: "code",
+					Scope:        "openid profile email",
+				},
+				Apps: []string{"files", "search", "preview", "text-editor", "pdf-viewer", "external", "user-management"},
+				Options: map[string]interface{}{
+					"hideSearchBar": false,
+				},
+			},
+		},
+	}
+}
+
+func EnsureDefaults(cfg *config.Config) {
+	// provide with defaults for shared logging, since we need a valid destination address for BindEnv.
+	if cfg.Log == nil && cfg.Commons != nil && cfg.Commons.Log != nil {
+		cfg.Log = &config.Log{
+			Level:  cfg.Commons.Log.Level,
+			Pretty: cfg.Commons.Log.Pretty,
+			Color:  cfg.Commons.Log.Color,
+			File:   cfg.Commons.Log.File,
+		}
+	} else if cfg.Log == nil {
+		cfg.Log = &config.Log{}
+	}
+	// provide with defaults for shared tracing, since we need a valid destination address for BindEnv.
+	if cfg.Tracing == nil && cfg.Commons != nil && cfg.Commons.Tracing != nil {
+		cfg.Tracing = &config.Tracing{
+			Enabled:   cfg.Commons.Tracing.Enabled,
+			Type:      cfg.Commons.Tracing.Type,
+			Endpoint:  cfg.Commons.Tracing.Endpoint,
+			Collector: cfg.Commons.Tracing.Collector,
+		}
+	} else if cfg.Tracing == nil {
+		cfg.Tracing = &config.Tracing{}
+	}
+}
+
+func Sanitize(cfg *config.Config) {
+	// sanitize config
+	if cfg.HTTP.Root != "/" {
+		cfg.HTTP.Root = strings.TrimRight(cfg.HTTP.Root, "/")
+	}
+	// build well known openid-configuration endpoint if it is not set
+	if cfg.Web.Config.OpenIDConnect.MetadataURL == "" {
+		cfg.Web.Config.OpenIDConnect.MetadataURL = strings.TrimRight(cfg.Web.Config.OpenIDConnect.Authority, "/") + "/.well-known/openid-configuration"
+	}
+}
@@ -0,0 +1,9 @@
+package config
+
+// HTTP defines the available http configuration.
+type HTTP struct {
+	Addr      string `yaml:"addr" env:"WEB_HTTP_ADDR"`
+	Namespace string `yaml:"-"`
+	Root      string `yaml:"root" env:"WEB_HTTP_ROOT"`
+	CacheTTL  int    `yaml:"cache_ttl" env:"WEB_CACHE_TTL"`
+}
@@ -0,0 +1,9 @@
+package config
+
+// Log defines the available log configuration.
+type Log struct {
+	Level  string `mapstructure:"level" env:"OCIS_LOG_LEVEL;WEB_LOG_LEVEL" desc:"The log level. Valid values are: \"panic\", \"fatal\", \"error\", \"warn\", \"info\", \"debug\", \"trace\"."`
+	Pretty bool   `mapstructure:"pretty" env:"OCIS_LOG_PRETTY;WEB_LOG_PRETTY" desc:"Activates pretty log output."`
+	Color  bool   `mapstructure:"color" env:"OCIS_LOG_COLOR;WEB_LOG_COLOR" desc:"Activates colorized log output."`
+	File   string `mapstructure:"file" env:"OCIS_LOG_FILE;WEB_LOG_FILE" desc:"The path to the log file. Activates logging to this file if set."`
+}
@@ -0,0 +1,37 @@
+package parser
+
+import (
+	"errors"
+
+	"github.com/owncloud/ocis/v2/extensions/web/pkg/config"
+	"github.com/owncloud/ocis/v2/extensions/web/pkg/config/defaults"
+	ociscfg "github.com/owncloud/ocis/v2/ocis-pkg/config"
+
+	"github.com/owncloud/ocis/v2/ocis-pkg/config/envdecode"
+)
+
+// ParseConfig loads configuration from known paths.
+func ParseConfig(cfg *config.Config) error {
+	_, err := ociscfg.BindSourcesToStructs(cfg.Service.Name, cfg)
+	if err != nil {
+		return err
+	}
+
+	defaults.EnsureDefaults(cfg)
+
+	// load all env variables relevant to the config in the current context.
+	if err := envdecode.Decode(cfg); err != nil {
+		// no environment variable set for this config is an expected "error"
+		if !errors.Is(err, envdecode.ErrNoTargetFieldsAreSet) {
+			return err
+		}
+	}
+
+	defaults.Sanitize(cfg)
+
+	return Validate(cfg)
+}
+
+func Validate(cfg *config.Config) error {
+	return nil
+}
@@ -0,0 +1,6 @@
+package config
+
+// Service defines the available service configuration.
+type Service struct {
+	Name string `yaml:"-"`
+}
@@ -0,0 +1,9 @@
+package config
+
+// Tracing defines the available tracing configuration.
+type Tracing struct {
+	Enabled   bool   `yaml:"enabled" env:"OCIS_TRACING_ENABLED;WEB_TRACING_ENABLED" desc:"Activates tracing."`
+	Type      string `yaml:"type" env:"OCIS_TRACING_TYPE;WEB_TRACING_TYPE" desc:"The type of tracing. Defaults to \"\", which is the same as \"jaeger\". Allowed tracing types are \"jaeger\" and \"\" as of now."`
+	Endpoint  string `yaml:"endpoint" env:"OCIS_TRACING_ENDPOINT;WEB_TRACING_ENDPOINT" desc:"The endpoint of the tracing agent."`
+	Collector string `yaml:"collector" env:"OCIS_TRACING_COLLECTOR;WEB_TRACING_COLLECTOR" desc:"The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset."`
+}