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"
@@ -39,8 +40,16 @@ type GetBookmarksOptions struct {
 
 // GetAccountsOptions is options for fetching accounts from database.
 type GetAccountsOptions struct {
-	Keyword string
-	Owner   bool
+	Keyword       string
+	Owner         bool
+	Showid        bool
+	Listmode      bool
+	Hidethumbnail bool
+	Hideexcerpt   bool
+	Nightmode     bool
+	Keepmetadata  bool
+	Usearchive    bool
+	Makepublic    bool
 }
 
 // DB is interface for accessing and manipulating data in database.
@@ -66,6 +75,9 @@ type DB interface {
 	// SaveAccount saves new account in database
 	SaveAccount(ctx context.Context, a model.Account) error
 
+	// SaveSettings saves settings for specific user in database
+	SaveSettings(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 +120,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,9 @@
 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',
+		configures VARCHAR(500) NOT NULL,
 		PRIMARY KEY (id),
 		UNIQUE KEY account_username_UNIQUE (username))
 		CHARACTER SET utf8mb4;

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

@@ -3,6 +3,7 @@ CREATE TABLE IF NOT EXISTS account(
 		username VARCHAR(250) NOT NULL,
 		password BYTEA    NOT NULL,
 		owner    BOOLEAN  NOT NULL DEFAULT FALSE,
+		configures VARCHAR(500) NOT NULL,
 		PRIMARY KEY (id),
 		CONSTRAINT account_username_UNIQUE UNIQUE (username));
 
@@ -33,4 +34,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/sqlite/0001_initial.up.sql

@@ -3,6 +3,7 @@ CREATE TABLE IF NOT EXISTS account(
     username TEXT NOT NULL,
     password TEXT NOT NULL,
     owner INTEGER NOT NULL DEFAULT 0,
+    configures TEXT NOT NULL,
     CONSTRAINT account_PK PRIMARY KEY(id),
     CONSTRAINT account_username_UNIQUE UNIQUE(username)
 );

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, configures) VALUES (?, ?, ?, ?)
 		ON DUPLICATE KEY UPDATE
 		password = VALUES(password),
 		owner = VALUES(owner)`,
-		account.Username, hashedPassword, account.Owner)
+		account.Username, hashedPassword, account.Owner, account.Configures)
+
+	return errors.WithStack(err)
+}
+
+// SaveSettings update settings for specific account  in database. Returns error if any happened
+func (db *MySQLDatabase) SaveSettings(ctx context.Context, account model.Account) (err error) {
+	err = IsJson(account.Configures)
+	if err != nil {
+		return errors.WithStack(err)
+	}
+	// Update account configures in database for specific user
+	_, err = db.ExecContext(ctx, `UPDATE account
+		SET configures = ?
+		WHERE username = ?`,
+		account.Configures, 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, configures 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, configures 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, configures) 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.Configures)
+
+	return errors.WithStack(err)
+}
+
+// SaveSettings update settings for specific account  in database. Returns error if any happened
+func (db *PGDatabase) SaveSettings(ctx context.Context, account model.Account) (err error) {
+	err = IsJson(account.Configures)
+	if err != nil {
+		return errors.WithStack(err)
+	}
+
+	// Insert account to database
+	_, err = db.ExecContext(ctx, `UPDATE account
+   		SET configures = $1
+   		WHERE username = $2`,
+		account.Configures, 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, configures 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, configures 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, configures) VALUES (?, ?, ?, ?)
 		ON CONFLICT(username) DO UPDATE SET
 		password = ?, owner = ?`,
-			account.Username, hashedPassword, account.Owner,
-			hashedPassword, account.Owner)
+			account.Username, hashedPassword, account.Owner, account.Configures,
+			hashedPassword, account.Owner, account.Configures)
+		return errors.WithStack(err)
+	}); err != nil {
+		return errors.WithStack(err)
+	}
+
+	return nil
+}
+
+// SaveSettings update settings for specific account  in database. Returns error if any happened.
+func (db *SQLiteDatabase) SaveSettings(ctx context.Context, account model.Account) error {
+	if err := db.withTx(ctx, func(tx *sqlx.Tx) error {
+		err := IsJson(account.Configures)
+		if err != nil {
+			return err
+		}
+
+		// Update account configures in database for specific user
+		_, err = tx.Exec(`UPDATE account
+	   SET configures = ?
+	   WHERE username = ?`,
+			account.Configures, 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, configures 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, configures 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"`
+	Configures string `db:"configures"           json:"configures"`
 }

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,
+                configures: 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 defaultconfigures = {
+                        showId: false,
+                        listMode: false,
+                        hideThumbnail: false,
+                        hideExcerpt: false,
+                        nightMode: false,
+                        keepMetadata: false,
+                        useArchive: false,
+                        makePublic: false
+                    };
+                    data.configures = JSON.stringify(defaultconfigures);
 
 					var request = {
 						username: data.username,
 						password: data.password,
 						owner: !data.visitor,
+                        configures: data.configures,
 					}
 
 					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 configures = JSON.parse(json.account.configures);
+                        localStorage.setItem("shiori-setting", JSON.stringify(configures));
 
 						// Go to destination page
 						var currentUrl = new Url,