Add config options for task attachments (#125)

Add config options for task attachments

Co-authored-by: kolaente <k@knt.li>
Reviewed-on: https://kolaente.dev/vikunja/api/pulls/125

config.yml.sample

@@ -24,6 +24,8 @@ service:
   enablelinksharing: true
   # Whether to let new users registering themselves or not
   enableregistration: true
+  # Whether to enable task attachments or not
+  enabletaskattachments: true
 
 database:
   # Database type to use. Supported types are mysql and sqlite.

docs/content/doc/setup/config.md

@@ -67,6 +67,8 @@ service:
   enablelinksharing: true
   # Whether to let new users registering themselves or not
   enableregistration: true
+  # Whether to enable task attachments or not
+  enabletaskattachments: true
 
 database:
   # Database type to use. Supported types are mysql and sqlite.

pkg/config/config.go

@@ -33,16 +33,17 @@ type Key string
 
 // These constants hold all config value keys
 const (
-	ServiceJWTSecret          Key = `service.JWTSecret`
-	ServiceInterface          Key = `service.interface`
-	ServiceFrontendurl        Key = `service.frontendurl`
-	ServiceEnableCaldav       Key = `service.enablecaldav`
-	ServiceRootpath           Key = `service.rootpath`
-	ServiceMaxItemsPerPage    Key = `service.maxitemsperpage`
-	ServiceEnableMetrics      Key = `service.enablemetrics`
-	ServiceMotd               Key = `service.motd`
-	ServiceEnableLinkSharing  Key = `service.enablelinksharing`
-	ServiceEnableRegistration Key = `service.enableregistration`
+	ServiceJWTSecret             Key = `service.JWTSecret`
+	ServiceInterface             Key = `service.interface`
+	ServiceFrontendurl           Key = `service.frontendurl`
+	ServiceEnableCaldav          Key = `service.enablecaldav`
+	ServiceRootpath              Key = `service.rootpath`
+	ServiceMaxItemsPerPage       Key = `service.maxitemsperpage`
+	ServiceEnableMetrics         Key = `service.enablemetrics`
+	ServiceMotd                  Key = `service.motd`
+	ServiceEnableLinkSharing     Key = `service.enablelinksharing`
+	ServiceEnableRegistration    Key = `service.enableregistration`
+	ServiceEnableTaskAttachments Key = `service.enabletaskattachments`
 
 	DatabaseType                  Key = `database.type`
 	DatabaseHost                  Key = `database.host`
@@ -166,6 +167,7 @@ func InitDefaultConfig() {
 	ServiceMotd.setDefault("")
 	ServiceEnableLinkSharing.setDefault(true)
 	ServiceEnableRegistration.setDefault(true)
+	ServiceEnableTaskAttachments.setDefault(true)
 
 	// Database
 	DatabaseType.setDefault("sqlite")

pkg/routes/api/v1/info.go

@@ -24,13 +24,14 @@ import (
 )
 
 type vikunjaInfos struct {
-	Version             string   `json:"version"`
-	FrontendURL         string   `json:"frontend_url"`
-	Motd                string   `json:"motd"`
-	LinkSharingEnabled  bool     `json:"link_sharing_enabled"`
-	MaxFileSize         string   `json:"max_file_size"`
-	RegistrationEnabled bool     `json:"registration_enabled"`
-	AvailableMigrators  []string `json:"available_migrators"`
+	Version                string   `json:"version"`
+	FrontendURL            string   `json:"frontend_url"`
+	Motd                   string   `json:"motd"`
+	LinkSharingEnabled     bool     `json:"link_sharing_enabled"`
+	MaxFileSize            string   `json:"max_file_size"`
+	RegistrationEnabled    bool     `json:"registration_enabled"`
+	AvailableMigrators     []string `json:"available_migrators"`
+	TaskAttachmentsEnabled bool     `json:"task_attachments_enabled"`
 }
 
 // Info is the handler to get infos about this vikunja instance
@@ -42,12 +43,13 @@ type vikunjaInfos struct {
 // @Router /info [get]
 func Info(c echo.Context) error {
 	infos := vikunjaInfos{
-		Version:             version.Version,
-		FrontendURL:         config.ServiceFrontendurl.GetString(),
-		Motd:                config.ServiceMotd.GetString(),
-		LinkSharingEnabled:  config.ServiceEnableLinkSharing.GetBool(),
-		MaxFileSize:         config.FilesMaxSize.GetString(),
-		RegistrationEnabled: config.ServiceEnableRegistration.GetBool(),
+		Version:                version.Version,
+		FrontendURL:            config.ServiceFrontendurl.GetString(),
+		Motd:                   config.ServiceMotd.GetString(),
+		LinkSharingEnabled:     config.ServiceEnableLinkSharing.GetBool(),
+		MaxFileSize:            config.FilesMaxSize.GetString(),
+		RegistrationEnabled:    config.ServiceEnableRegistration.GetBool(),
+		TaskAttachmentsEnabled: config.ServiceEnableTaskAttachments.GetBool(),
 	}
 	if config.MigrationWunderlistEnable.GetBool() {
 		infos.AvailableMigrators = append(infos.AvailableMigrators, "wunderlist")

pkg/routes/routes.go

@@ -288,15 +288,17 @@ func registerAPIRoutes(a *echo.Group) {
 	a.PUT("/tasks/:task/relations", taskRelationHandler.CreateWeb)
 	a.DELETE("/tasks/:task/relations", taskRelationHandler.DeleteWeb)
 
-	taskAttachmentHandler := &handler.WebHandler{
-		EmptyStruct: func() handler.CObject {
-			return &models.TaskAttachment{}
-		},
+	if config.ServiceEnableTaskAttachments.GetBool() {
+		taskAttachmentHandler := &handler.WebHandler{
+			EmptyStruct: func() handler.CObject {
+				return &models.TaskAttachment{}
+			},
+		}
+		a.GET("/tasks/:task/attachments", taskAttachmentHandler.ReadAllWeb)
+		a.DELETE("/tasks/:task/attachments/:attachment", taskAttachmentHandler.DeleteWeb)
+		a.PUT("/tasks/:task/attachments", apiv1.UploadTaskAttachment)
+		a.GET("/tasks/:task/attachments/:attachment", apiv1.GetTaskAttachment)
 	}
-	a.GET("/tasks/:task/attachments", taskAttachmentHandler.ReadAllWeb)
-	a.DELETE("/tasks/:task/attachments/:attachment", taskAttachmentHandler.DeleteWeb)
-	a.PUT("/tasks/:task/attachments", apiv1.UploadTaskAttachment)
-	a.GET("/tasks/:task/attachments/:attachment", apiv1.GetTaskAttachment)
 
 	labelHandler := &handler.WebHandler{
 		EmptyStruct: func() handler.CObject {