use custom struct for web options

Signed-off-by: jkoberg <[email protected]>

changelog/unreleased/web-config.md

@@ -0,0 +1,5 @@
+Enhancement: Web options configuration
+
+Hardcode web options instead of using a generic `map[string]interface{}`
+
+https://github.com/owncloud/ocis/pull/6188

services/web/pkg/config/config.go

@@ -51,16 +51,16 @@ type CustomTranslation struct {
 
 // 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" desc:"URL, where the oCIS APIs are reachable for ownCloud Web."`
-	Theme         string                 `json:"theme,omitempty" yaml:"-"`
-	OpenIDConnect OIDC                   `json:"openIdConnect,omitempty" yaml:"oidc"`
-	Apps          []string               `json:"apps" yaml:"apps"`
-	Applications  []Application          `json:"applications,omitempty" yaml:"applications"`
-	ExternalApps  []ExternalApp          `json:"external_apps,omitempty" yaml:"external_apps"`
-	Options       map[string]interface{} `json:"options,omitempty" yaml:"options"`
-	Styles        []CustomStyle          `json:"styles,omitempty" yaml:"styles"`
-	Scripts       []CustomScript         `json:"scripts,omitempty" yaml:"scripts"`
-	Translations  []CustomTranslation    `json:"customTranslations,omitempty" yaml:"custom_translations"`
+	Server        string              `json:"server,omitempty" yaml:"server" env:"OCIS_URL;WEB_UI_CONFIG_SERVER" desc:"URL, where the oCIS APIs are reachable for ownCloud Web."`
+	Theme         string              `json:"theme,omitempty" yaml:"-"`
+	OpenIDConnect OIDC                `json:"openIdConnect,omitempty" yaml:"oidc"`
+	Apps          []string            `json:"apps" yaml:"apps"`
+	Applications  []Application       `json:"applications,omitempty" yaml:"applications"`
+	ExternalApps  []ExternalApp       `json:"external_apps,omitempty" yaml:"external_apps"`
+	Options       Options             `json:"options,omitempty" yaml:"options"`
+	Styles        []CustomStyle       `json:"styles,omitempty" yaml:"styles"`
+	Scripts       []CustomScript      `json:"scripts,omitempty" yaml:"scripts"`
+	Translations  []CustomTranslation `json:"customTranslations,omitempty" yaml:"custom_translations"`
 }
 
 // OIDC defines the available oidc configuration

services/web/pkg/config/defaults/defaultconfig.go

@@ -66,8 +66,8 @@ func DefaultConfig() *config.Config {
 						},
 					},
 				},
-				Options: map[string]interface{}{
-					"previewFileMimeTypes": []string{"image/gif", "image/png", "image/jpeg", "text/plain", "image/tiff", "image/bmp", "image/x-ms-bmp"},
+				Options: config.Options{
+					PreviewFileMimeTypes: []string{"image/gif", "image/png", "image/jpeg", "text/plain", "image/tiff", "image/bmp", "image/x-ms-bmp"},
 				},
 			},
 		},

services/web/pkg/config/options.go

@@ -0,0 +1,65 @@
+package config
+
+// Options are the option for the web
+type Options struct {
+	HomeFolder               string          `json:"homeFolder" yaml:"homeFolder" env:"WEB_OPTION_HOME_FOLDER" desc:"You can specify a folder that is used when the user navigates 'home'. Navigating home gets triggered by clicking on the 'All files' menu item. The user will not be jailed in that directory. It simply serves as a default location. You can either provide a static location, or you can use variables of the user object to come up with a user specific home path. This uses twig template variable style and allows you to pick a value or a substring of a value of the authenticated user. Examples are '/Shares', '/{{.Id}}' and '/{{substr 0 3 .Id}}/{{.Id}'."`
+	OpenAppsInTab            bool            `json:"openAppsInTab" yaml:"openAppsInTab" env:"WEB_OPTION_OPEN_APPS_IN_TAB" desc:"Configures whether apps and extensions generally should open in a new tab. Defaults to false."`
+	DisablePreviews          bool            `json:"disablePreviews" yaml:"disablePreviews" env:"WEB_OPTION_DISABLE_PREVIEWS" desc:"Set this option to 'true' to disable previews in all the different file listing views. The only list view that is not affected by this is the trash bin, as that doesn't allow showing previews at all."`
+	PreviewFileMimeTypes     []string        `json:"previewFileMimeTypes" yaml:"previewFileMimeTypes" env:"WEB_OPTION_PREVIEW_FILE_MIMETYPES" desc:"Specifies which mimeTypes will be previewed in the ui. For example to only preview jpg and text files set this option to ['image/jpeg', 'text/plain']."`
+	AccountEditLink          AccountEditLink `json:"accountEditLink" yaml:"accountEditLink"`
+	DisableFeedbackLink      bool            `json:"disableFeedbackLink" yaml:"disableFeedbackLink" env:"WEB_OPTION_DISABLE_FEEDBACK_LINK" desc:"Set this option to 'true' to disable the feedback link in the topbar. Keeping it enabled (value 'false' or absence of the option) allows ownCloud to get feedback from your user base through a dedicated survey website."`
+	FeedbackLink             FeedbackLink    `json:"feedbackLink" yaml:"feedbackLink"`
+	SharingRecipientsPerPage int             `json:"sharingRecipientsPerPage" yaml:"sharingRecipientsPerPage" env:"WEB_OPTION_SHARING_RECIPIENTS_PER_PAGE" desc:"Sets the amount of users shown as recipients in the dropdown when sharing resources. Default amount is 200."`
+	Sidebar                  Sidebar         `json:"sidebar" yaml:"sidebar"`
+	RunningOnEOS             bool            `json:"runningOnEos" yaml:"runningOnEos" env:"WEB_OPTION_RUNNING_ON_EOS" desc:"Set this option to 'true' if running on an [EOS storage backend](https://eos-web.web.cern.ch/eos-web/) to enable its specific features. Defaults to 'false'."`
+	CernFeatures             bool            `json:"cernFeatures" yaml:"cernFeatures" env:"WEB_OPTION_CERN_FEATURES" desc:"Enabling this will activate CERN-specific features. Defaults to 'false'."`
+	HoverableQuickActions    bool            `json:"hoverableQuickActions" yaml:"hoverableQuickActions" env:"WEB_OPTION_HOVERABLE_QUICK_ACTIONS" desc:"Set this option to 'true' to hide the quick actions (buttons appearing on file rows), and only show them when the user hovers the row with his mouse. Defaults to 'false'."`
+	Routing                  Routing         `json:"routing" yaml:"routing"`
+	Upload                   Upload          `json:"upload" yaml:"upload"`
+	Editor                   Editor          `json:"editor" yaml:"editor"`
+	ContextHelpersReadMore   bool            `json:"contextHelpersReadMore" yaml:"contextHelpersReadMore" env:"WEB_OPTION_CONTEXTHELPERS_READ_MORE" desc:"Specifies whether the 'Read more' link should be displayed or not."`
+	LogoutURL                string          `json:"logoutURL" yaml:"logoutURL" env:"WEB_OPTION_LOGOUT_URL" desc:"The logout url"`
+}
+
+// AccountEditLink are the AccountEditLink options
+type AccountEditLink struct {
+	Href string `json:"href" yaml:"href" env:"WEB_OPTION_ACCOUNT_EDIT_LINK_HREF" desc:"Set a different target URL for the edit link. Make sure to prepend it with 'http(s)://'."`
+}
+
+// FeedbackLink are the feedback link options
+type FeedbackLink struct {
+	Href        string `json:"href" yaml:"href" env:"WEB_OPTION_FEEDBACKLINK_HREF" desc:"Set a different target URL for the feedback link. Make sure to prepend it with 'http(s)://'. Defaults to 'https://owncloud.com/web-design-feedback'.`
+	AriaLabel   string `json:"ariaLabel" yaml:"ariaLabel" env:"WEB_OPTION_ARIALABEL" desc:"Since the link only has an icon, you can set an e.g. screen reader accessible label. Defaults to 'ownCloud feedback survey'.`
+	Description string `json:"description" yaml:"description" env:"WEB_OPTION_DESCRIPTION" desc:"Provide any description you want to see as tooltip and as accessible description. Defaults to 'Provide your feedback: We'd like to improve the web design and would be happy to hear your feedback. Thank you! Your ownCloud team'.`
+}
+
+// Sidebar are the side bar option
+type Sidebar struct {
+	Shares SidebarShares `json:"shares" yaml:"shares"`
+}
+
+// SidebarShares are the options for the shares side bar
+type SidebarShares struct {
+	ShowAllOnLoad bool `json:"showAllOnLoad" yaml:"showAllOnLoad" env:"WEB_OPTION_SIDEBAR_SHARES_SHOW_ALL_ON_LOAD" desc:"Sets the list of (link) shares list in the sidebar to be initially expanded (default is a collapsed state, only showing the first three shares)."`
+}
+
+// Routing are the routing options
+type Routing struct {
+	IDBased bool `json:"idBased" yaml:"idBased" env:"WEB_OPTION_ROUTING_ID_BASED" desc:"Enable or disable fileIds being added to the URL. Defaults to 'true' because otherwise e.g. spaces with name clashes can't be resolved correctly. Only disable this if you can guarantee server side that spaces of the same namespace can't have name clashes."`
+}
+
+// Upload are the upload options
+type Upload struct {
+	XHR XHR `json:"xhr" yaml:"xhr"`
+}
+
+// XHR are the XHR options
+type XHR struct {
+	Timeout int `json:"timeout" yaml:"timeout" desc:"Specifies the timeout for XHR uploads in milliseconds."`
+}
+
+// Editor are the web editor options
+type Editor struct {
+	AutosaveEnabled  bool `json:"autosaveEnabled" yaml:"autosaveEnabled" env:"WEB_OPTION_EDITOR_AUTOSAVE_ENABLED" desc:"Specifies if the autosave for the editor apps is enabled."`
+	AutosaveInterval int  `json:"autosaveInterval" yaml:"autosaveInterval" env:"WEB_OPTION_EDITOR_AUTOSAVE_INTERVAL" desc:"Specifies the time interval for the autosave of editor apps in seconds."`
+}