feat: allow per-user settings and store them in database

docs/swagger/docs.go

@@ -15,6 +15,38 @@ const docTemplate = `{
     "host": "{{.Host}}",
     "basePath": "{{.BasePath}}",
     "paths": {
+        "/api/v1/auth/account": {
+            "patch": {
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Auth"
+                ],
+                "summary": "Perform actions on the currently logged-in user.",
+                "parameters": [
+                    {
+                        "description": "Config data",
+                        "name": "payload",
+                        "in": "body",
+                        "schema": {
+                            "$ref": "#/definitions/api_v1.settingRequestPayload"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/model.Account"
+                        }
+                    },
+                    "403": {
+                        "description": "Token not provided/invalid"
+                    }
+                }
+            }
+        },
         "/api/v1/auth/login": {
             "post": {
                 "consumes": [
@@ -175,9 +207,20 @@ const docTemplate = `{
                 }
             }
         },
+        "api_v1.settingRequestPayload": {
+            "type": "object",
+            "properties": {
+                "config": {
+                    "$ref": "#/definitions/model.UserConfig"
+                }
+            }
+        },
         "model.Account": {
             "type": "object",
             "properties": {
+                "config": {
+                    "$ref": "#/definitions/model.UserConfig"
+                },
                 "id": {
                     "type": "integer"
                 },
@@ -205,6 +248,35 @@ const docTemplate = `{
                     "type": "string"
                 }
             }
+        },
+        "model.UserConfig": {
+            "type": "object",
+            "properties": {
+                "HideExcerpt": {
+                    "type": "boolean"
+                },
+                "HideThumbnail": {
+                    "type": "boolean"
+                },
+                "KeepMetadata": {
+                    "type": "boolean"
+                },
+                "ListMode": {
+                    "type": "boolean"
+                },
+                "MakePublic": {
+                    "type": "boolean"
+                },
+                "NightMode": {
+                    "type": "boolean"
+                },
+                "ShowId": {
+                    "type": "boolean"
+                },
+                "UseArchive": {
+                    "type": "boolean"
+                }
+            }
         }
     }
 }`

docs/swagger/swagger.json

@@ -4,6 +4,38 @@
         "contact": {}
     },
     "paths": {
+        "/api/v1/auth/account": {
+            "patch": {
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Auth"
+                ],
+                "summary": "Perform actions on the currently logged-in user.",
+                "parameters": [
+                    {
+                        "description": "Config data",
+                        "name": "payload",
+                        "in": "body",
+                        "schema": {
+                            "$ref": "#/definitions/api_v1.settingRequestPayload"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/model.Account"
+                        }
+                    },
+                    "403": {
+                        "description": "Token not provided/invalid"
+                    }
+                }
+            }
+        },
         "/api/v1/auth/login": {
             "post": {
                 "consumes": [
@@ -164,9 +196,20 @@
                 }
             }
         },
+        "api_v1.settingRequestPayload": {
+            "type": "object",
+            "properties": {
+                "config": {
+                    "$ref": "#/definitions/model.UserConfig"
+                }
+            }
+        },
         "model.Account": {
             "type": "object",
             "properties": {
+                "config": {
+                    "$ref": "#/definitions/model.UserConfig"
+                },
                 "id": {
                     "type": "integer"
                 },
@@ -194,6 +237,35 @@
                     "type": "string"
                 }
             }
+        },
+        "model.UserConfig": {
+            "type": "object",
+            "properties": {
+                "HideExcerpt": {
+                    "type": "boolean"
+                },
+                "HideThumbnail": {
+                    "type": "boolean"
+                },
+                "KeepMetadata": {
+                    "type": "boolean"
+                },
+                "ListMode": {
+                    "type": "boolean"
+                },
+                "MakePublic": {
+                    "type": "boolean"
+                },
+                "NightMode": {
+                    "type": "boolean"
+                },
+                "ShowId": {
+                    "type": "boolean"
+                },
+                "UseArchive": {
+                    "type": "boolean"
+                }
+            }
         }
     }
 }

docs/swagger/swagger.yaml

@@ -22,8 +22,15 @@ definitions:
       token:
         type: string
     type: object
+  api_v1.settingRequestPayload:
+    properties:
+      config:
+        $ref: '#/definitions/model.UserConfig'
+    type: object
   model.Account:
     properties:
+      config:
+        $ref: '#/definitions/model.UserConfig'
       id:
         type: integer
       owner:
@@ -42,9 +49,48 @@ definitions:
       name:
         type: string
     type: object
+  model.UserConfig:
+    properties:
+      HideExcerpt:
+        type: boolean
+      HideThumbnail:
+        type: boolean
+      KeepMetadata:
+        type: boolean
+      ListMode:
+        type: boolean
+      MakePublic:
+        type: boolean
+      NightMode:
+        type: boolean
+      ShowId:
+        type: boolean
+      UseArchive:
+        type: boolean
+    type: object
 info:
   contact: {}
 paths:
+  /api/v1/auth/account:
+    patch:
+      parameters:
+      - description: Config data
+        in: body
+        name: payload
+        schema:
+          $ref: '#/definitions/api_v1.settingRequestPayload'
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/model.Account'
+        "403":
+          description: Token not provided/invalid
+      summary: Perform actions on the currently logged-in user.
+      tags:
+      - Auth
   /api/v1/auth/login:
     post:
       consumes:

internal/database/database.go

@@ -89,6 +89,9 @@ type DB interface {
 	// SaveAccount saves new account in database
 	SaveAccount(ctx context.Context, a model.Account) error
 
+	// SaveAccountSettings saves settings for specific user in database
+	SaveAccountSettings(ctx context.Context, a model.Account) error
+
 	// GetAccounts fetch list of account (without its password) with matching keyword.
 	GetAccounts(ctx context.Context, opts GetAccountsOptions) ([]model.Account, error)
 

internal/database/migrations/mysql/0001_initial.up.sql

@@ -1,8 +1,8 @@
 CREATE TABLE IF NOT EXISTS account(
-		id       INT(11)      NOT NULL AUTO_INCREMENT,
-		username VARCHAR(250) NOT NULL,
-		password BINARY(80)   NOT NULL,
-		owner    TINYINT(1)   NOT NULL DEFAULT '0',
+		id       INT(11)        NOT NULL AUTO_INCREMENT,
+		username VARCHAR(250)   NOT NULL,
+		password BINARY(80)     NOT NULL,
+		owner    TINYINT(1)     NOT NULL DEFAULT '0',
 		PRIMARY KEY (id),
 		UNIQUE KEY account_username_UNIQUE (username))
 		CHARACTER SET utf8mb4;

internal/database/migrations/mysql/0005_config.down.sql

@@ -0,0 +1 @@
+ALTER TABLE account DROP COLUMN config;

internal/database/migrations/mysql/0005_config.up.sql

@@ -0,0 +1,2 @@
+ALTER TABLE account
+    ADD COLUMN config JSON NOT NULL DEFAULT '{}';

internal/database/migrations/postgres/0001_initial.up.sql

@@ -33,4 +33,4 @@ CREATE TABLE IF NOT EXISTS bookmark_tag(
 		CONSTRAINT bookmark_tag_tag_id_FK FOREIGN KEY (tag_id) REFERENCES tag (id));
 
 CREATE INDEX IF NOT EXISTS bookmark_tag_bookmark_id_FK ON bookmark_tag (bookmark_id);
-CREATE INDEX IF NOT EXISTS bookmark_tag_tag_id_FK ON bookmark_tag (tag_id);
+CREATE INDEX IF NOT EXISTS bookmark_tag_tag_id_FK ON bookmark_tag (tag_id);

internal/database/migrations/postgres/0002_config.down.sql

@@ -0,0 +1 @@
+ALTER TABLE account DROP COLUMN config;

internal/database/migrations/postgres/0002_config.up.sql

@@ -0,0 +1,2 @@
+ALTER TABLE account
+    ADD COLUMN config JSONB NOT NULL DEFAULT '{}';

internal/database/migrations/sqlite/0003_config.down.sql

@@ -0,0 +1 @@
+ALTER TABLE account DROP COLUMN config;

internal/database/migrations/sqlite/0003_config.up.sql

@@ -0,0 +1,3 @@
+ALTER TABLE account
+    ADD config JSON NOT NULL DEFAULT '{}';
+

internal/database/mysql.go

@@ -532,11 +532,22 @@ func (db *MySQLDatabase) SaveAccount(ctx context.Context, account model.Account)
 
 	// Insert account to database
 	_, err = db.ExecContext(ctx, `INSERT INTO account
-		(username, password, owner) VALUES (?, ?, ?)
+		(username, password, owner, config) VALUES (?, ?, ?, ?)
 		ON DUPLICATE KEY UPDATE
 		password = VALUES(password),
 		owner = VALUES(owner)`,
-		account.Username, hashedPassword, account.Owner)
+		account.Username, hashedPassword, account.Owner, account.Config)
+
+	return errors.WithStack(err)
+}
+
+// SaveAccountSettings update settings for specific account  in database. Returns error if any happened
+func (db *MySQLDatabase) SaveAccountSettings(ctx context.Context, account model.Account) (err error) {
+	// Update account config in database for specific user
+	_, err = db.ExecContext(ctx, `UPDATE account
+		SET config = ?
+		WHERE username = ?`,
+		account.Config, account.Username)
 
 	return errors.WithStack(err)
 }
@@ -545,7 +556,7 @@ func (db *MySQLDatabase) SaveAccount(ctx context.Context, account model.Account)
 func (db *MySQLDatabase) GetAccounts(ctx context.Context, opts GetAccountsOptions) ([]model.Account, error) {
 	// Create query
 	args := []interface{}{}
-	query := `SELECT id, username, owner FROM account WHERE 1`
+	query := `SELECT id, username, owner, config FROM account WHERE 1`
 
 	if opts.Keyword != "" {
 		query += " AND username LIKE ?"
@@ -573,7 +584,7 @@ func (db *MySQLDatabase) GetAccounts(ctx context.Context, opts GetAccountsOption
 func (db *MySQLDatabase) GetAccount(ctx context.Context, username string) (model.Account, bool, error) {
 	account := model.Account{}
 	if err := db.GetContext(ctx, &account, `SELECT
-		id, username, password, owner FROM account WHERE username = ?`,
+		id, username, password, owner, config FROM account WHERE username = ?`,
 		username,
 	); err != nil {
 		return account, false, errors.WithStack(err)