config

type AppProvider struct {
	Port
	ExternalAddr string     `ocisConfig:"external_addr"`
	Driver       string     `ocisConfig:"driver"`
	WopiDriver   WopiDriver `ocisConfig:"wopi_driver"`
	AppsURL      string     `ocisConfig:"apps_url"`
	OpenURL      string     `ocisConfig:"open_url"`
}

type AppRegistry struct {
	Driver        string `ocisConfig:"driver"`
	MimetypesJSON string `ocisConfig:"mime_types_json"`
}

type Archiver struct {
	MaxNumFiles int64  `ocisConfig:"max_num_files"`
	MaxSize     int64  `ocisConfig:"max_size"`
	ArchiverURL string `ocisConfig:"archiver_url"`
}

type Asset struct {
	Path string `ocisConfig:"path"`
}

type Auth struct {
	CredentialsByUserAgent map[string]string `ocisConfig:"credentials_by_user_agenr"`
}

type AuthMachineConfig struct {
	MachineAuthAPIKey string `ocisConfig:"machine_auth_api_key"`
}

type Config struct {
	*shared.Commons

	File    string      `ocisConfig:"file"`
	Log     *shared.Log `ocisConfig:"log"`
	Debug   Debug       `ocisConfig:"debug"`
	Reva    Reva        `ocisConfig:"reva"`
	Tracing Tracing     `ocisConfig:"tracing"`
	Asset   Asset       `ocisConfig:"asset"`
}

type DataGatewayPort struct {
	Port
	PublicURL string `ocisConfig:""`
}

type DataProvider struct {
	Insecure bool `ocisConfig:"insecure"`
}

type Debug struct {
	Addr   string `ocisConfig:"addr"`
	Token  string `ocisConfig:"token"`
	Pprof  bool   `ocisConfig:"pprof"`
	Zpages bool   `ocisConfig:"zpages"`
}

type DriverCommon struct {
	// Root is the absolute path to the location of the data
	Root string `ocisConfig:"root"`
	//ShareFolder defines the name of the folder jailing all shares
	ShareFolder string `ocisConfig:"share_folder"`
	// UserLayout contains the template used to construct
	// the internal path, eg: `{{substr 0 1 .Username}}/{{.Username}}`
	UserLayout string `ocisConfig:"user_layout"`
	// EnableHome enables the creation of home directories.
	EnableHome bool `ocisConfig:"enable_home"`
}

type DriverEOS struct {
	DriverCommon

	// ShadowNamespace for storing shadow data
	ShadowNamespace string `ocisConfig:"shadow_namespace"`

	// UploadsNamespace for storing upload data
	UploadsNamespace string `ocisConfig:"uploads_namespace"`

	// Location of the eos binary.
	// Default is /usr/bin/eos.
	EosBinary string `ocisConfig:"eos_binary"`

	// Location of the xrdcopy binary.
	// Default is /usr/bin/xrdcopy.
	XrdcopyBinary string `ocisConfig:"xrd_copy_binary"`

	// URL of the Master EOS MGM.
	// Default is root://eos-example.org
	MasterURL string `ocisConfig:"master_url"`

	// URI of the EOS MGM grpc server
	// Default is empty
	GrpcURI string `ocisConfig:"grpc_uri"`

	// URL of the Slave EOS MGM.
	// Default is root://eos-example.org
	SlaveURL string `ocisConfig:"slave_url"`

	// Location on the local fs where to store reads.
	// Defaults to os.TempDir()
	CacheDirectory string `ocisConfig:"cache_directory"`

	// Enables logging of the commands executed
	// Defaults to false
	EnableLogging bool `ocisConfig:"enable_logging"`

	// ShowHiddenSysFiles shows internal EOS files like
	// .sys.v# and .sys.a# files.
	ShowHiddenSysFiles bool `ocisConfig:"shadow_hidden_files"`

	// ForceSingleUserMode will force connections to EOS to use SingleUsername
	ForceSingleUserMode bool `ocisConfig:"force_single_user_mode"`

	// UseKeyTabAuth changes will authenticate requests by using an EOS keytab.
	UseKeytab bool `ocisConfig:"user_keytab"`

	// SecProtocol specifies the xrootd security protocol to use between the server and EOS.
	SecProtocol string `ocisConfig:"sec_protocol"`

	// Keytab specifies the location of the keytab to use to authenticate to EOS.
	Keytab string `ocisConfig:"keytab"`

	// SingleUsername is the username to use when SingleUserMode is enabled
	SingleUsername string `ocisConfig:"single_username"`

	// gateway service to use for uid lookups
	GatewaySVC string `ocisConfig:"gateway_svc"`
}

type DriverOCIS struct {
	DriverCommon

	ServiceUserUUID string `ocisConfig:"service_user_uuid"`
}

type DriverOwnCloud struct {
	DriverCommon

	UploadInfoDir string `ocisConfig:"upload_info_dir"`
	Redis         string `ocisConfig:"redis"`
	Scan          bool   `ocisConfig:"scan"`
}

type DriverOwnCloudSQL struct {
	DriverCommon

	UploadInfoDir string `ocisConfig:"upload_info_dir"`
	DBUsername    string `ocisConfig:"db_username"`
	DBPassword    string `ocisConfig:"db_password"`
	DBHost        string `ocisConfig:"db_host"`
	DBPort        int    `ocisConfig:"db_port"`
	DBName        string `ocisConfig:"db_name"`
}

type DriverS3 struct {
	DriverCommon

	Region    string `ocisConfig:"region"`
	AccessKey string `ocisConfig:"access_key"`
	SecretKey string `ocisConfig:"secret_key"`
	Endpoint  string `ocisConfig:"endpoint"`
	Bucket    string `ocisConfig:"bucket"`
}

type DriverS3NG struct {
	DriverCommon

	ServiceUserUUID string `ocisConfig:"service_user_uuid"`
	Region          string `ocisConfig:"region"`
	AccessKey       string `ocisConfig:"access_key"`
	SecretKey       string `ocisConfig:"secret_key"`
	Endpoint        string `ocisConfig:"endpoint"`
	Bucket          string `ocisConfig:"bucket"`
}

type FrontendPort struct {
	Port

	AppProviderInsecure        bool       `ocisConfig:"app_provider_insecure"`
	AppProviderPrefix          string     `ocisConfig:"app_provider_prefix"`
	ArchiverInsecure           bool       `ocisConfig:"archiver_insecure"`
	ArchiverPrefix             string     `ocisConfig:"archiver_prefix"`
	DatagatewayPrefix          string     `ocisConfig:"data_gateway_prefix"`
	Favorites                  bool       `ocisConfig:"favorites"`
	OCDavInsecure              bool       `ocisConfig:"ocdav_insecure"`
	OCDavPrefix                string     `ocisConfig:"ocdav_prefix"`
	OCSPrefix                  string     `ocisConfig:"ocs_prefix"`
	OCSSharePrefix             string     `ocisConfig:"ocs_share_prefix"`
	OCSHomeNamespace           string     `ocisConfig:"ocs_home_namespace"`
	PublicURL                  string     `ocisConfig:"public_url"`
	OCSCacheWarmupDriver       string     `ocisConfig:"ocs_cache_warmup_driver"`
	OCSAdditionalInfoAttribute string     `ocisConfig:"ocs_additional_info_attribute"`
	OCSResourceInfoCacheTTL    int        `ocisConfig:"ocs_resource_info_cache_ttl"`
	Middleware                 Middleware `ocisConfig:"middleware"`
}

type Gateway struct {
	Port
	CommitShareToStorageGrant  bool   `ocisConfig:"commit_share_to_storage_grant"`
	CommitShareToStorageRef    bool   `ocisConfig:"commit_share_to_storage_ref"`
	DisableHomeCreationOnLogin bool   `ocisConfig:"disable_home_creation_on_login"`
	ShareFolder                string `ocisConfig:"share_folder"`
	LinkGrants                 string `ocisConfig:"link_grants"`
	HomeMapping                string `ocisConfig:"home_mapping"`
	EtagCacheTTL               int    `ocisConfig:"etag_cache_ttl"`
}

type Groups struct {
	Port
	Driver                      string `ocisConfig:"driver"`
	JSON                        string `ocisConfig:"json"`
	GroupMembersCacheExpiration int    `ocisConfig:"group_members_cache_expiration"`
}

type LDAP struct {
	Hostname             string          `ocisConfig:"hostname"`
	Port                 int             `ocisConfig:"port"`
	CACert               string          `ocisConfig:"ca_cert"`
	Insecure             bool            `ocisConfig:"insecure"`
	BaseDN               string          `ocisConfig:"base_dn"`
	LoginFilter          string          `ocisConfig:"login_filter"`
	UserFilter           string          `ocisConfig:"user_filter"`
	UserAttributeFilter  string          `ocisConfig:"user_attribute_filter"`
	UserFindFilter       string          `ocisConfig:"user_find_filter"`
	UserGroupFilter      string          `ocisConfig:"user_group_filter"`
	GroupFilter          string          `ocisConfig:"group_filter"`
	GroupAttributeFilter string          `ocisConfig:"group_attribute_filter"`
	GroupFindFilter      string          `ocisConfig:"group_finder_filter"`
	GroupMemberFilter    string          `ocisConfig:"group_member_filter"`
	BindDN               string          `ocisConfig:"bind_dn"`
	BindPassword         string          `ocisConfig:"bind_password"`
	IDP                  string          `ocisConfig:"idp"`
	UserSchema           LDAPUserSchema  `ocisConfig:"user_schema"`
	GroupSchema          LDAPGroupSchema `ocisConfig:"group_schema"`
}

type LDAPGroupSchema struct {
	GID         string `ocisConfig:"gid"`
	Mail        string `ocisConfig:"mail"`
	DisplayName string `ocisConfig:"display_name"`
	CN          string `ocisConfig:"cn"`
	GIDNumber   string `ocisConfig:"gid_number"`
}

type LDAPUserSchema struct {
	UID         string `ocisConfig:"uid"`
	Mail        string `ocisConfig:"mail"`
	DisplayName string `ocisConfig:"display_name"`
	CN          string `ocisConfig:"cn"`
	UIDNumber   string `ocisConfig:"uid_number"`
	GIDNumber   string `ocisConfig:"gid_number"`
}

type Log struct {
	Level  string `ocisConfig:"level"`
	Pretty bool   `ocisConfig:"pretty"`
	Color  bool   `ocisConfig:"color"`
	File   string `ocisConfig:"file"`
}

type Middleware struct {
	Auth Auth `ocisConfig:"auth"`
}

type OCDav struct {
	WebdavNamespace   string `ocisConfig:"webdav_namespace"`
	DavFilesNamespace string `ocisConfig:"dav_files_namespace"`
}

type OIDC struct {
	Issuer   string `ocisConfig:"issuer"`
	Insecure bool   `ocisConfig:"insecure"`
	IDClaim  string `ocisConfig:"id_claim"`
	UIDClaim string `ocisConfig:"uid_claim"`
	GIDClaim string `ocisConfig:"gid_claim"`
}

type Port struct {
	// MaxCPUs can be a number or a percentage
	MaxCPUs  string `ocisConfig:"max_cpus"`
	LogLevel string `ocisConfig:"log_level"`
	// GRPCNetwork can be tcp, udp or unix
	GRPCNetwork string `ocisConfig:"grpc_network"`
	// GRPCAddr to listen on, hostname:port (0.0.0.0:9999 for all interfaces) or socket (/var/run/reva/sock)
	GRPCAddr string `ocisConfig:"grpc_addr"`
	// Protocol can be grpc or http
	// HTTPNetwork can be tcp, udp or unix
	HTTPNetwork string `ocisConfig:"http_network"`
	// HTTPAddr to listen on, hostname:port (0.0.0.0:9100 for all interfaces) or socket (/var/run/reva/sock)
	HTTPAddr string `ocisConfig:"http_addr"`
	// Protocol can be grpc or http
	Protocol string `ocisConfig:"protocol"`
	// Endpoint is used by the gateway and registries (eg localhost:9100 or cloud.example.com)
	Endpoint string `ocisConfig:"endpoint"`
	// DebugAddr for the debug endpoint to bind to
	DebugAddr string `ocisConfig:"debug_addr"`
	// Services can be used to give a list of services that should be started on this port
	Services []string `ocisConfig:"services"`
	// Config can be used to configure the reva instance.
	// Services and Protocol will be ignored if this is used
	Config map[string]interface{} `ocisConfig:"config"`

	// Context allows for context cancellation and propagation
	Context context.Context

	// Supervised is used when running under an oCIS runtime supervision tree
	Supervised bool // deprecated
}

type PublicStorage struct {
	StoragePort

	PublicShareProviderAddr string `ocisConfig:"public_share_provider_addr"`
	UserProviderAddr        string `ocisConfig:"user_provider_addr"`
}

type Reva struct {
	// JWTSecret used to sign jwt tokens between services
	JWTSecret             string          `ocisConfig:"jwt_secret"`
	SkipUserGroupsInToken bool            `ocisConfig:"skip_user_grooups_in_token"`
	TransferSecret        string          `ocisConfig:"transfer_secret"`
	TransferExpires       int             `ocisConfig:"transfer_expires"`
	OIDC                  OIDC            `ocisConfig:"oidc"`
	LDAP                  LDAP            `ocisConfig:"ldap"`
	UserGroupRest         UserGroupRest   `ocisConfig:"user_group_rest"`
	UserOwnCloudSQL       UserOwnCloudSQL `ocisConfig:"user_owncloud_sql"`
	OCDav                 OCDav           `ocisConfig:"ocdav"`
	Archiver              Archiver        `ocisConfig:"archiver"`
	UserStorage           StorageConfig   `ocisConfig:"user_storage"`
	MetadataStorage       StorageConfig   `ocisConfig:"metadata_storage"`
	// Ports are used to configure which services to start on which port
	Frontend          FrontendPort      `ocisConfig:"frontend"`
	DataGateway       DataGatewayPort   `ocisConfig:"data_gateway"`
	Gateway           Gateway           `ocisConfig:"gateway"`
	StorageRegistry   StorageRegistry   `ocisConfig:"storage_registry"`
	AppRegistry       AppRegistry       `ocisConfig:"app_registry"`
	Users             Users             `ocisConfig:"users"`
	Groups            Groups            `ocisConfig:"groups"`
	AuthProvider      Users             `ocisConfig:"auth_provider"`
	AuthBasic         Port              `ocisConfig:"auth_basic"`
	AuthBearer        Port              `ocisConfig:"auth_bearer"`
	AuthMachine       Port              `ocisConfig:"auth_machine"`
	AuthMachineConfig AuthMachineConfig `ocisConfig:"auth_machine_config"`
	Sharing           Sharing           `ocisConfig:"sharing"`
	StorageHome       StoragePort       `ocisConfig:"storage_home"`
	StorageUsers      StoragePort       `ocisConfig:"storage_users"`
	StoragePublicLink PublicStorage     `ocisConfig:"storage_public_link"`
	StorageMetadata   StoragePort       `ocisConfig:"storage_metadata"`
	AppProvider       AppProvider       `ocisConfig:"app_provider"`
	// Configs can be used to configure the reva instance.
	// Services and Ports will be ignored if this is used
	Configs map[string]interface{} `ocisConfig:"configs"`
	// chunking and resumable upload config (TUS)
	UploadMaxChunkSize       int    `ocisConfig:"uppload_max_chunk_size"`
	UploadHTTPMethodOverride string `ocisConfig:"upload_http_method_override"`
	// checksumming capabilities
	ChecksumSupportedTypes      []string `ocisConfig:"checksum_supported_types"`
	ChecksumPreferredUploadType string   `ocisConfig:"checksum_preferred_upload_type"`
	DefaultUploadProtocol       string   `ocisConfig:"default_upload_protocol"`
}

type Sharing struct {
	Port
	UserDriver                       string `ocisConfig:"user_driver"`
	UserJSONFile                     string `ocisConfig:"user_json_file"`
	UserSQLUsername                  string `ocisConfig:"user_sql_username"`
	UserSQLPassword                  string `ocisConfig:"user_sql_password"`
	UserSQLHost                      string `ocisConfig:"user_sql_host"`
	UserSQLPort                      int    `ocisConfig:"user_sql_port"`
	UserSQLName                      string `ocisConfig:"user_sql_name"`
	PublicDriver                     string `ocisConfig:"public_driver"`
	PublicJSONFile                   string `ocisConfig:"public_json_file"`
	PublicPasswordHashCost           int    `ocisConfig:"public_password_hash_cost"`
	PublicEnableExpiredSharesCleanup bool   `ocisConfig:"public_enable_expired_shares_cleanup"`
	PublicJanitorRunInterval         int    `ocisConfig:"public_janitor_run_interval"`
	UserStorageMountID               string `ocisConfig:"user_storage_mount_id"`
}

type StorageConfig struct {
	EOS         DriverEOS         `ocisConfig:"eos"`
	Local       DriverCommon      `ocisConfig:"local"`
	OwnCloud    DriverOwnCloud    `ocisConfig:"owncloud"`
	OwnCloudSQL DriverOwnCloudSQL `ocisConfig:"owncloud_sql"`
	S3          DriverS3          `ocisConfig:"s3"`
	S3NG        DriverS3NG        `ocisConfig:"s3ng"`
	OCIS        DriverOCIS        `ocisConfig:"ocis"`
}

type StoragePort struct {
	Port
	Driver           string `ocisConfig:"driver"`
	MountPath        string `ocisConfig:"mount_path"`
	MountID          string `ocisConfig:"mount_id"`
	AlternativeID    string `ocisConfig:"alternative_id"`
	ExposeDataServer bool   `ocisConfig:"expose_data_server"`
	// url the data gateway will use to route requests
	DataServerURL string `ocisConfig:"data_server_url"`

	// for HTTP ports with only one http service
	HTTPPrefix   string       `ocisConfig:"http_prefix"`
	TempFolder   string       `ocisConfig:"temp_folder"`
	ReadOnly     bool         `ocisConfig:"read_only"`
	DataProvider DataProvider `ocisConfig:"data_provider"`
}

type StorageRegistry struct {
	Driver string `ocisConfig:"driver"`
	// HomeProvider is the path in the global namespace that the static storage registry uses to determine the home storage
	HomeProvider string   `ocisConfig:"home_provider"`
	Rules        []string `ocisConfig:"rules"`
	JSON         string   `ocisConfig:"json"`
}

type Tracing struct {
	Enabled   bool   `ocisConfig:"enabled"`
	Type      string `ocisConfig:"type"`
	Endpoint  string `ocisConfig:"endpoint"`
	Collector string `ocisConfig:"collector"`
	Service   string `ocisConfig:"service"`
}

type UserGroupRest struct {
	ClientID          string `ocisConfig:"client_id"`
	ClientSecret      string `ocisConfig:"client_secret"`
	RedisAddress      string `ocisConfig:"redis_address"`
	RedisUsername     string `ocisConfig:"redis_username"`
	RedisPassword     string `ocisConfig:"redis_password"`
	IDProvider        string `ocisConfig:"idp_provider"`
	APIBaseURL        string `ocisConfig:"api_base_url"`
	OIDCTokenEndpoint string `ocisConfig:"oidc_token_endpoint"`
	TargetAPI         string `ocisConfig:"target_api"`
}

type UserOwnCloudSQL struct {
	DBUsername         string `ocisConfig:"db_username"`
	DBPassword         string `ocisConfig:"db_password"`
	DBHost             string `ocisConfig:"db_host"`
	DBPort             int    `ocisConfig:"db_port"`
	DBName             string `ocisConfig:"db_name"`
	Idp                string `ocisConfig:"idp"`
	Nobody             int64  `ocisConfig:"nobody"`
	JoinUsername       bool   `ocisConfig:"join_username"`
	JoinOwnCloudUUID   bool   `ocisConfig:"join_owncloud_uuid"`
	EnableMedialSearch bool   `ocisConfig:"enable_medial_search"`
}

type Users struct {
	Port
	Driver                    string `ocisConfig:"driver"`
	JSON                      string `ocisConfig:"json"`
	UserGroupsCacheExpiration int    `ocisConfig:"user_groups_cache_expiration"`
}

type WopiDriver struct {
	AppAPIKey      string `ocisConfig:"app_api_key"`
	AppDesktopOnly bool   `ocisConfig:"app_desktop_only"`
	AppIconURI     string `ocisConfig:"app_icon_uri"`
	AppInternalURL string `ocisConfig:"app_internal_url"`
	AppName        string `ocisConfig:"app_name"`
	AppURL         string `ocisConfig:"app_url"`
	Insecure       bool   `ocisConfig:"insecure"`
	IopSecret      string `ocisConfig:"ipo_secret"`
	JWTSecret      string `ocisConfig:"jwt_secret"`
	WopiURL        string `ocisConfig:"wopi_url"`
}