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

internal/database/database.go

@@ -3,6 +3,7 @@ package database
 import (
 	"context"
 	"embed"
+	"encoding/json"
 	"log"
 
 	"github.com/go-shiori/shiori/internal/model"
@@ -66,6 +67,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)
 
@@ -108,3 +112,14 @@ func (db *dbbase) withTx(ctx context.Context, fn func(tx *sqlx.Tx) error) error
 
 	return err
 }
+
+// get a string and return errors if it is not in json format
+func IsJson(input string) error {
+	var jsonData interface{}
+	err := json.Unmarshal([]byte(input), &jsonData)
+	if err != nil {
+		return err
+	} else {
+		return nil
+	}
+}

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.up.sql

@@ -0,0 +1,2 @@
+ALTER TABLE account
+    ADD COLUMN config VARCHAR(500) NOT NULL DEFAULT '{"showId":false,"listMode":false,"hideThumbnail":false,"hideExcerpt":false,"nightMode":false,"keepMetadata":false,"useArchive":false,"makePublic":false}';

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.up.sql

@@ -0,0 +1,3 @@
+ALTER TABLE account
+    ADD COLUMN config VARCHAR(500) NOT NULL DEFAULT '{"showId":false,"listMode":false,"hideThumbnail":false,"hideExcerpt":false,"nightMode":false,"keepMetadata":false,"useArchive":false,"makePublic":false}';
+

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

@@ -0,0 +1,3 @@
+ALTER TABLE account
+    ADD config TEXT NOT NULL DEFAULT '{"showId":false,"listMode":false,"hideThumbnail":false,"hideExcerpt":false,"nightMode":false,"keepMetadata":false,"useArchive":false,"makePublic":false}';
+

internal/database/mysql.go

@@ -532,11 +532,26 @@ 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) {
+	err = IsJson(account.Config)
+	if err != nil {
+		return errors.WithStack(err)
+	}
+	// 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 +560,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 +588,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)

internal/database/pg.go

@@ -542,11 +542,27 @@ func (db *PGDatabase) SaveAccount(ctx context.Context, account model.Account) (e
 
 	// Insert account to database
 	_, err = db.ExecContext(ctx, `INSERT INTO account
-		(username, password, owner) VALUES ($1, $2, $3)
+		(username, password, owner, config) VALUES ($1, $2, $3, $4)
 		ON CONFLICT(username) DO UPDATE SET
 		password = $2,
 		owner = $3`,
-		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 *PGDatabase) SaveAccountSettings(ctx context.Context, account model.Account) (err error) {
+	err = IsJson(account.Config)
+	if err != nil {
+		return errors.WithStack(err)
+	}
+
+	// Insert account to database
+	_, err = db.ExecContext(ctx, `UPDATE account
+   		SET config = $1
+   		WHERE username = $2`,
+		account.Config, account.Username)
 
 	return errors.WithStack(err)
 }
@@ -555,7 +571,7 @@ func (db *PGDatabase) SaveAccount(ctx context.Context, account model.Account) (e
 func (db *PGDatabase) GetAccounts(ctx context.Context, opts GetAccountsOptions) ([]model.Account, error) {
 	// Create query
 	args := []interface{}{}
-	query := `SELECT id, username, owner FROM account WHERE TRUE`
+	query := `SELECT id, username, owner, config FROM account WHERE TRUE`
 
 	if opts.Keyword != "" {
 		query += " AND username LIKE $1"
@@ -583,7 +599,7 @@ func (db *PGDatabase) GetAccounts(ctx context.Context, opts GetAccountsOptions)
 func (db *PGDatabase) 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 = $1`,
+		id, username, password, owner, config FROM account WHERE username = $1`,
 		username,
 	); err != nil {
 		return account, false, errors.WithStack(err)

internal/database/sqlite.go

@@ -649,11 +649,32 @@ func (db *SQLiteDatabase) SaveAccount(ctx context.Context, account model.Account
 
 		// Insert account to database
 		_, err = tx.Exec(`INSERT INTO account
-		(username, password, owner) VALUES (?, ?, ?)
+		(username, password, owner, config) VALUES (?, ?, ?, ?)
 		ON CONFLICT(username) DO UPDATE SET
 		password = ?, owner = ?`,
-			account.Username, hashedPassword, account.Owner,
-			hashedPassword, account.Owner)
+			account.Username, hashedPassword, account.Owner, account.Config,
+			hashedPassword, account.Owner, account.Config)
+		return errors.WithStack(err)
+	}); err != nil {
+		return errors.WithStack(err)
+	}
+
+	return nil
+}
+
+// SaveAccountSettings update settings for specific account  in database. Returns error if any happened.
+func (db *SQLiteDatabase) SaveAccountSettings(ctx context.Context, account model.Account) error {
+	if err := db.withTx(ctx, func(tx *sqlx.Tx) error {
+		err := IsJson(account.Config)
+		if err != nil {
+			return err
+		}
+
+		// Update account config in database for specific user
+		_, err = tx.Exec(`UPDATE account
+	   SET config = ?
+	   WHERE username = ?`,
+			account.Config, account.Username)
 		return errors.WithStack(err)
 	}); err != nil {
 		return errors.WithStack(err)
@@ -666,7 +687,7 @@ func (db *SQLiteDatabase) SaveAccount(ctx context.Context, account model.Account
 func (db *SQLiteDatabase) 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 ?"
@@ -694,7 +715,7 @@ func (db *SQLiteDatabase) GetAccounts(ctx context.Context, opts GetAccountsOptio
 func (db *SQLiteDatabase) 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)

internal/model/model.go

@@ -30,8 +30,9 @@ type Bookmark struct {
 
 // Account is person that allowed to access web interface.
 type Account struct {
-	ID       int    `db:"id"       json:"id"`
-	Username string `db:"username" json:"username"`
-	Password string `db:"password" json:"password,omitempty"`
-	Owner    bool   `db:"owner"    json:"owner"`
+	ID       int    `db:"id"                   json:"id"`
+	Username string `db:"username"             json:"username"`
+	Password string `db:"password"             json:"password,omitempty"`
+	Owner    bool   `db:"owner"                json:"owner"`
+	Config   string `db:"config"               json:"config"`
 }

internal/view/index.html

@@ -92,6 +92,7 @@
 								return response;
 							}).then(() => {
 								localStorage.removeItem("shiori-account");
+								localStorage.removeItem("shiori-setting");
 								document.cookie = `session-id=; Path=${new URL(document.baseURI).pathname}; Expires=Thu, 01 Jan 1970 00:00:00 GMT;`;
 								location.href = new URL("login", document.baseURI);
 							}).catch(err => {
@@ -173,4 +174,4 @@
 	</script>
 </body>
 
-</html>
+</html>

internal/view/js/page/setting.js

@@ -85,16 +85,40 @@ export default {
 		saveSetting() {
 			this.$emit("setting-changed", {
 				showId: this.appOptions.showId,
-				listMode: this.appOptions.listMode,
-				hideThumbnail: this.appOptions.hideThumbnail,
-				hideExcerpt: this.appOptions.hideExcerpt,
-				nightMode: this.appOptions.nightMode,
-				keepMetadata: this.appOptions.keepMetadata,
-				useArchive: this.appOptions.useArchive,
-				makePublic: this.appOptions.makePublic,
-			});
-		},
-		loadAccounts() {
+                listMode: this.appOptions.listMode,
+                hideThumbnail: this.appOptions.hideThumbnail,
+                hideExcerpt: this.appOptions.hideExcerpt,
+                nightMode: this.appOptions.nightMode,
+                keepMetadata: this.appOptions.keepMetadata,
+                useArchive: this.appOptions.useArchive,
+                makePublic: this.appOptions.makePublic,
+            });
+            const request = {
+                username: this.activeAccount.username,
+                config: JSON.stringify(this.appOptions)
+            };
+            // TODO: DO i need loading page? if no remove this.dialog.loading = false
+            fetch(new URL("api/accountssettings", document.baseURI), {
+                method: "put",
+                body: JSON.stringify(request),
+                headers: {
+                    "Content-Type": "application/json",
+                },
+            }).then(response => {
+                if (!response.ok) throw response;
+                return response;
+            }).then(() => {
+                this.dialog.loading = false;
+                this.dialog.visible = false;
+            }).catch(err => {
+                this.dialog.loading = false;
+                this.getErrorMessage(err).then(msg => {
+                    this.showErrorDialog(msg);
+                })
+            });
+
+        },
+        loadAccounts() {
 			if (this.loading) return;
 
 			this.loading = true;
@@ -155,11 +179,23 @@ export default {
 						this.showErrorDialog("Password does not match");
 						return;
 					}
+                    const defaultconfig = {
+                        showId: false,
+                        listMode: false,
+                        hideThumbnail: false,
+                        hideExcerpt: false,
+                        nightMode: false,
+                        keepMetadata: false,
+                        useArchive: false,
+                        makePublic: false
+                    };
+                    data.config = JSON.stringify(defaultconfig);
 
 					var request = {
 						username: data.username,
 						password: data.password,
 						owner: !data.visitor,
+                        config: data.config,
 					}
 
 					this.dialog.loading = true;
@@ -301,4 +337,4 @@ export default {
 	mounted() {
 		this.loadAccounts();
 	}
-}
+}

internal/view/login.html

@@ -109,6 +109,8 @@
 
 						// Save account data
 						localStorage.setItem("shiori-account", JSON.stringify(json.account));
+                        const config = JSON.parse(json.account.config);
+                        localStorage.setItem("shiori-setting", JSON.stringify(config));
 
 						// Go to destination page
 						var currentUrl = new Url,

internal/webserver/handler-api.go

@@ -108,6 +108,7 @@ func (h *handler) apiLogin(w http.ResponseWriter, r *http.Request, ps httprouter
 		genSession(model.Account{
 			Username: "shiori",
 			Owner:    true,
+			Config:   "{\"showId\":false,\"listMode\":false,\"hideThumbnail\":false,\"hideExcerpt\":false,\"nightMode\":false,\"keepMetadata\":false,\"useArchive\":false,\"makePublic\":false}",
 		}, time.Hour)
 		return
 	}
@@ -846,6 +847,40 @@ func (h *handler) apiUpdateAccount(w http.ResponseWriter, r *http.Request, ps ht
 	fmt.Fprint(w, 1)
 }
 
+// apiUpdateSettings is handler for PUT /api/accounts
+func (h *handler) apiUpdateSettings(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
+	ctx := r.Context()
+
+	// Make sure session still valid
+	err := h.validateSession(r)
+	checkError(err)
+
+	// Decode request
+	request := struct {
+		Username string `json:"username"`
+		Config   string `json:"config"`
+	}{}
+
+	err = json.NewDecoder(r.Body).Decode(&request)
+	checkError(err)
+
+	// Get existing account data from database
+	account, exist, err := h.DB.GetAccount(ctx, request.Username)
+	checkError(err)
+
+	if !exist {
+		panic(fmt.Errorf("username doesn't exist"))
+	}
+
+	// Save new password to database
+	account.Config = request.Config
+	//	account.Owner = request.Owner
+	err = h.DB.SaveAccountSettings(ctx, account)
+	checkError(err)
+
+	fmt.Fprint(w, 1)
+}
+
 // apiDeleteAccount is handler for DELETE /api/accounts
 func (h *handler) apiDeleteAccount(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
 	ctx := r.Context()

internal/webserver/server.go

@@ -202,6 +202,7 @@ func ServeApp(cfg Config) error {
 
 	router.GET(jp("/api/accounts"), withLogging(hdl.apiGetAccounts))
 	router.PUT(jp("/api/accounts"), withLogging(hdl.apiUpdateAccount))
+	router.PUT(jp("/api/accountssettings"), withLogging(hdl.apiUpdateSettings))
 	router.POST(jp("/api/accounts"), withLogging(hdl.apiInsertAccount))
 	router.DELETE(jp("/api/accounts"), withLogging(hdl.apiDeleteAccount))