shiori/internal/database/sqlite.go
Felipe Martin 876d27f337
refactor: remove gin and use stdlib http server (#1064)
* refactor: base http server stdlib

* refactor: swagger and frontend routes

* fix: use global middlewares

* refactor: removed gin from testutils

* fix: object references in legacy webserver

* refactor: legacy, swagger and system handlers

* fix: added verbs to handlers

* fix: server handlers ordering

* refactor: bookmarks handlers

* refactor: system api routes

* tests: bookmark handlers

* refactor: migrated api auth routes

* chore: remove unused middlewares

* docs: add swagger docs to refactored system api

* chore: remove old auth routes

* refactor: account apis

* chore: removed old handlers

* fix: api v1 handlers missing middlewares

* refactor: migrated tag list route

* refactor: bookmark routes

* refactor: remove gin

* chore: make styles

* test: fixed tests

* test: generate binary file without text

* fix: global middleware missing from system api handler

* fix: incorrect api handler

* chore: avoid logging screenshot contents

* tests: bookmarks domain

* tests: shortcuts

* test: missing tests

* tests: server tests

* test: remove test using syscall to avoid windows errors

* chore: added middlewares
2025-02-26 20:50:48 +01:00

1017 lines
30 KiB
Go

package database
import (
"context"
"database/sql"
"fmt"
"log"
"runtime"
"strings"
"time"
"github.com/go-shiori/shiori/internal/model"
"github.com/jmoiron/sqlx"
"github.com/pkg/errors"
_ "modernc.org/sqlite"
)
var sqliteMigrations = []migration{
newFileMigration("0.0.0", "0.1.0", "sqlite/0000_system"),
newFileMigration("0.1.0", "0.2.0", "sqlite/0001_initial"),
newFuncMigration("0.2.0", "0.3.0", func(db *sql.DB) error {
// Ensure that bookmark table has `has_content` column and account table has `config` column
// for users upgrading from <1.5.4 directly into this version.
tx, err := db.Begin()
if err != nil {
return fmt.Errorf("failed to start transaction: %w", err)
}
defer tx.Rollback()
_, err = tx.Exec(`ALTER TABLE bookmark ADD COLUMN has_content BOOLEAN DEFAULT FALSE NOT NULL`)
if err != nil && strings.Contains(err.Error(), `duplicate column name`) {
tx.Rollback()
} else if err != nil {
return fmt.Errorf("failed to add has_content column to bookmark table: %w", err)
} else if err == nil {
if errCommit := tx.Commit(); errCommit != nil {
return fmt.Errorf("failed to commit transaction: %w", errCommit)
}
}
tx, err = db.Begin()
if err != nil {
return fmt.Errorf("failed to start transaction: %w", err)
}
defer tx.Rollback()
_, err = tx.Exec(`ALTER TABLE account ADD COLUMN config JSON NOT NULL DEFAULT '{}'`)
if err != nil && strings.Contains(err.Error(), `duplicate column name`) {
tx.Rollback()
} else if err != nil {
return fmt.Errorf("failed to add config column to account table: %w", err)
} else if err == nil {
if errCommit := tx.Commit(); errCommit != nil {
return fmt.Errorf("failed to commit transaction: %w", errCommit)
}
}
return nil
}),
newFileMigration("0.3.0", "0.4.0", "sqlite/0002_denormalize_content"),
newFileMigration("0.4.0", "0.5.0", "sqlite/0003_uniq_id"),
newFileMigration("0.5.0", "0.6.0", "sqlite/0004_created_time"),
}
// SQLiteDatabase is implementation of Database interface
// for connecting to SQLite3 database.
type SQLiteDatabase struct {
writer *dbbase
reader *dbbase
}
// withTx executes the given function within a transaction.
// If the function returns an error, the transaction is rolled back.
// Otherwise, the transaction is committed.
func (db *SQLiteDatabase) withTx(ctx context.Context, fn func(tx *sqlx.Tx) error) error {
tx, err := db.writer.BeginTxx(ctx, nil)
if err != nil {
return fmt.Errorf("failed to begin transaction: %w", err)
}
err = fn(tx)
if err != nil {
rbErr := tx.Rollback()
if rbErr != nil {
return fmt.Errorf("error rolling back: %v (original error: %w)", rbErr, err)
}
return fmt.Errorf("transaction failed: %w", err)
}
if err := tx.Commit(); err != nil {
return fmt.Errorf("failed to commit transaction: %w", err)
}
return nil
}
// withTxRetry executes the given function within a transaction with retry logic.
// It will retry up to 3 times if the database is locked, with exponential backoff.
// For other errors, it returns immediately.
func (db *SQLiteDatabase) withTxRetry(ctx context.Context, fn func(tx *sqlx.Tx) error) error {
maxRetries := 3
var lastErr error
for i := 0; i < maxRetries; i++ {
err := db.withTx(ctx, fn)
if err == nil {
return nil
}
if strings.Contains(err.Error(), "database is locked") {
lastErr = err
time.Sleep(time.Duration(i+1) * 100 * time.Millisecond)
continue
}
return fmt.Errorf("transaction failed after retry: %w", err)
}
return fmt.Errorf("transaction failed after max retries, last error: %w", lastErr)
}
// Init sets up the SQLite database with optimal settings for both reader and writer connections
func (db *SQLiteDatabase) Init(ctx context.Context) error {
// Initialize both connections with appropriate settings
for _, conn := range []*dbbase{db.writer, db.reader} {
// Reuse connections for up to one hour
conn.SetConnMaxLifetime(time.Hour)
// Enable WAL mode for better concurrency
if _, err := conn.ExecContext(ctx, `PRAGMA journal_mode=WAL`); err != nil {
return fmt.Errorf("failed to set journal mode: %w", err)
}
// Set busy timeout to avoid "database is locked" errors
if _, err := conn.ExecContext(ctx, `PRAGMA busy_timeout=5000`); err != nil {
return fmt.Errorf("failed to set busy timeout: %w", err)
}
// Other performance and reliability settings
pragmas := []string{
`PRAGMA synchronous=NORMAL`,
`PRAGMA cache_size=-2000`, // Use 2MB of memory for cache
`PRAGMA foreign_keys=ON`,
}
for _, pragma := range pragmas {
if _, err := conn.ExecContext(ctx, pragma); err != nil {
return fmt.Errorf("failed to set pragma %s: %w", pragma, err)
}
}
}
// Use a single connection on the writer to avoid database is locked errors
db.writer.SetMaxOpenConns(1)
// Set maximum idle connections for the reader to number of CPUs (maxing at 4)
db.reader.SetMaxIdleConns(max(4, runtime.NumCPU()))
return nil
}
type bookmarkContent struct {
ID int `db:"docid"`
Content string `db:"content"`
HTML string `db:"html"`
}
type tagContent struct {
ID int `db:"bookmark_id"`
model.Tag
}
// DBX returns the underlying sqlx.DB object for writes
func (db *SQLiteDatabase) WriterDB() *sqlx.DB {
return db.writer.DB
}
// ReaderDBx returns the underlying sqlx.DB object for reading
func (db *SQLiteDatabase) ReaderDB() *sqlx.DB {
return db.reader.DB
}
// Migrate runs migrations for this database engine
func (db *SQLiteDatabase) Migrate(ctx context.Context) error {
if err := runMigrations(ctx, db, sqliteMigrations); err != nil {
return fmt.Errorf("failed to run migrations: %w", err)
}
return nil
}
// GetDatabaseSchemaVersion fetches the current migrations version of the database
func (db *SQLiteDatabase) GetDatabaseSchemaVersion(ctx context.Context) (string, error) {
var version string
err := db.reader.GetContext(ctx, &version, "SELECT database_schema_version FROM shiori_system")
if err != nil {
return "", fmt.Errorf("failed to get database schema version: %w", err)
}
return version, nil
}
// SetDatabaseSchemaVersion sets the current migrations version of the database
func (db *SQLiteDatabase) SetDatabaseSchemaVersion(ctx context.Context, version string) error {
if err := db.withTxRetry(ctx, func(tx *sqlx.Tx) error {
_, err := tx.ExecContext(ctx, "UPDATE shiori_system SET database_schema_version = ?", version)
if err != nil {
return err
}
return nil
}); err != nil {
return fmt.Errorf("failed to set database schema version: %w", err)
}
return nil
}
// SaveBookmarks saves new or updated bookmarks to database.
// Returns the saved ID and error message if any happened.
func (db *SQLiteDatabase) SaveBookmarks(ctx context.Context, create bool, bookmarks ...model.BookmarkDTO) ([]model.BookmarkDTO, error) {
var result []model.BookmarkDTO
if err := db.withTxRetry(ctx, func(tx *sqlx.Tx) error {
// Prepare statement
stmtInsertBook, err := tx.PreparexContext(ctx, `INSERT INTO bookmark
(url, title, excerpt, author, public, modified_at, has_content, created_at)
VALUES(?, ?, ?, ?, ?, ?, ?, ?) RETURNING id`)
if err != nil {
return fmt.Errorf("failed to prepare insert book statement: %w", err)
}
stmtUpdateBook, err := tx.PreparexContext(ctx, `UPDATE bookmark SET
url = ?, title = ?, excerpt = ?, author = ?,
public = ?, modified_at = ?, has_content = ?
WHERE id = ?`)
if err != nil {
return fmt.Errorf("failed to prepare update book statement: %w", err)
}
stmtInsertBookContent, err := tx.PreparexContext(ctx, `INSERT OR REPLACE INTO bookmark_content
(docid, title, content, html)
VALUES (?, ?, ?, ?)`)
if err != nil {
return fmt.Errorf("failed to prepare insert book content statement: %w", err)
}
stmtUpdateBookContent, err := tx.PreparexContext(ctx, `UPDATE bookmark_content SET
title = ?, content = ?, html = ?
WHERE docid = ?`)
if err != nil {
return fmt.Errorf("failed to prepare update book content statement: %w", err)
}
stmtGetTag, err := tx.PreparexContext(ctx, `SELECT id FROM tag WHERE name = ?`)
if err != nil {
return fmt.Errorf("failed to prepare get tag statement: %w", err)
}
stmtInsertTag, err := tx.PreparexContext(ctx, `INSERT INTO tag (name) VALUES (?)`)
if err != nil {
return fmt.Errorf("failed to prepare insert tag statement: %w", err)
}
stmtInsertBookTag, err := tx.PreparexContext(ctx, `INSERT OR IGNORE INTO bookmark_tag
(tag_id, bookmark_id) VALUES (?, ?)`)
if err != nil {
return fmt.Errorf("failed to prepare insert book tag statement: %w", err)
}
stmtDeleteBookTag, err := tx.PreparexContext(ctx, `DELETE FROM bookmark_tag
WHERE bookmark_id = ? AND tag_id = ?`)
if err != nil {
return fmt.Errorf("failed to execute delete statement: %w", err)
}
// Prepare modified time
modifiedTime := time.Now().UTC().Format(model.DatabaseDateFormat)
// Execute statements
for _, book := range bookmarks {
// Check URL and title
if book.URL == "" {
return errors.New("URL must not be empty")
}
if book.Title == "" {
return errors.New("title must not be empty")
}
// Set modified time
if book.ModifiedAt == "" {
book.ModifiedAt = modifiedTime
}
hasContent := book.Content != ""
// Create or update bookmark
var err error
if create {
book.CreatedAt = modifiedTime
err = stmtInsertBook.QueryRowContext(ctx,
book.URL, book.Title, book.Excerpt, book.Author, book.Public, book.ModifiedAt, hasContent, book.CreatedAt).Scan(&book.ID)
} else {
_, err = stmtUpdateBook.ExecContext(ctx,
book.URL, book.Title, book.Excerpt, book.Author, book.Public, book.ModifiedAt, hasContent, book.ID)
}
if err != nil {
return fmt.Errorf("failed to delete bookmark content: %w", err)
}
// Try to update it first to check for existence, we can't do an UPSERT here because
// bookmant_content is a virtual table
res, err := stmtUpdateBookContent.ExecContext(ctx, book.Title, book.Content, book.HTML, book.ID)
if err != nil {
return fmt.Errorf("failed to delete bookmark tag: %w", err)
}
rows, err := res.RowsAffected()
if err != nil {
return fmt.Errorf("failed to delete bookmark: %w", err)
}
if rows == 0 {
_, err = stmtInsertBookContent.ExecContext(ctx, book.ID, book.Title, book.Content, book.HTML)
if err != nil {
return fmt.Errorf("failed to execute delete bookmark tag statement: %w", err)
}
}
// Save book tags
newTags := []model.TagDTO{}
for _, tag := range book.Tags {
t := tag.ToDTO()
// If it's deleted tag, delete and continue
if t.Deleted {
_, err = stmtDeleteBookTag.ExecContext(ctx, book.ID, tag.ID)
if err != nil {
return fmt.Errorf("failed to execute delete bookmark statement: %w", err)
}
continue
}
// Normalize tag name
tagName := strings.ToLower(tag.Name)
tagName = strings.Join(strings.Fields(tagName), " ")
// If tag doesn't have any ID, fetch it from database
if tag.ID == 0 {
if err := stmtGetTag.GetContext(ctx, &tag.ID, tagName); err != nil && err != sql.ErrNoRows {
return fmt.Errorf("failed to get tag ID: %w", err)
}
// If tag doesn't exist in database, save it
if tag.ID == 0 {
res, err := stmtInsertTag.ExecContext(ctx, tagName)
if err != nil {
return fmt.Errorf("failed to get last insert ID for tag: %w", err)
}
tagID64, err := res.LastInsertId()
if err != nil && err != sql.ErrNoRows {
return fmt.Errorf("failed to insert bookmark tag: %w", err)
}
tag.ID = int(tagID64)
}
if _, err := stmtInsertBookTag.ExecContext(ctx, tag.ID, book.ID); err != nil {
return fmt.Errorf("failed to execute bookmark tag statement: %w", err)
}
}
newTags = append(newTags, t)
}
book.Tags = newTags
result = append(result, book)
}
return nil
}); err != nil {
return nil, fmt.Errorf("failed to execute select query for bookmark content: %w", err)
}
return result, nil
}
// GetBookmarks fetch list of bookmarks based on submitted options.
func (db *SQLiteDatabase) GetBookmarks(ctx context.Context, opts model.DBGetBookmarksOptions) ([]model.BookmarkDTO, error) {
// Create initial query
query := `SELECT
b.id,
b.url,
b.title,
b.excerpt,
b.author,
b.public,
b.created_at,
b.modified_at,
b.has_content
FROM bookmark b
WHERE 1`
// Add where clause
args := []interface{}{}
// Add where clause for IDs
if len(opts.IDs) > 0 {
query += ` AND b.id IN (?)`
args = append(args, opts.IDs)
}
// Add where clause for search keyword
if opts.Keyword != "" {
query += ` AND (b.url LIKE '%' || ? || '%' OR b.excerpt LIKE '%' || ? || '%' OR b.id IN (
SELECT docid id
FROM bookmark_content
WHERE title MATCH ? OR content MATCH ?))`
args = append(args, opts.Keyword, opts.Keyword)
// Replace dash with spaces since FTS5 uses `-name` as column identifier and double quote
// since FTS5 uses double quote as string identifier
// Reference: https://sqlite.org/fts5.html#fts5_strings
ftsKeyword := strings.ReplaceAll(opts.Keyword, "-", " ")
// Properly set double quotes for string literals in sqlite's fts
ftsKeyword = strings.ReplaceAll(ftsKeyword, "\"", "\"\"")
args = append(args, "\""+ftsKeyword+"\"", "\""+ftsKeyword+"\"")
}
// Add where clause for tags.
// First we check for * in excluded and included tags,
// which means all tags will be excluded and included, respectively.
excludeAllTags := false
for _, excludedTag := range opts.ExcludedTags {
if excludedTag == "*" {
excludeAllTags = true
opts.ExcludedTags = []string{}
break
}
}
includeAllTags := false
for _, includedTag := range opts.Tags {
if includedTag == "*" {
includeAllTags = true
opts.Tags = []string{}
break
}
}
// If all tags excluded, we will only show bookmark without tags.
// In other hand, if all tags included, we will only show bookmark with tags.
if excludeAllTags {
query += ` AND b.id NOT IN (SELECT DISTINCT bookmark_id FROM bookmark_tag)`
} else if includeAllTags {
query += ` AND b.id IN (SELECT DISTINCT bookmark_id FROM bookmark_tag)`
}
// Now we only need to find the normal tags
if len(opts.Tags) > 0 {
query += ` AND b.id IN (
SELECT bt.bookmark_id
FROM bookmark_tag bt
LEFT JOIN tag t ON bt.tag_id = t.id
WHERE t.name IN(?)
GROUP BY bt.bookmark_id
HAVING COUNT(bt.bookmark_id) = ?)`
args = append(args, opts.Tags, len(opts.Tags))
}
if len(opts.ExcludedTags) > 0 {
query += ` AND b.id NOT IN (
SELECT DISTINCT bt.bookmark_id
FROM bookmark_tag bt
LEFT JOIN tag t ON bt.tag_id = t.id
WHERE t.name IN(?))`
args = append(args, opts.ExcludedTags)
}
// Add order clause
switch opts.OrderMethod {
case model.ByLastAdded:
query += ` ORDER BY b.id DESC`
case model.ByLastModified:
query += ` ORDER BY b.modified_at DESC`
default:
query += ` ORDER BY b.id`
}
if opts.Limit > 0 && opts.Offset >= 0 {
query += ` LIMIT ? OFFSET ?`
args = append(args, opts.Limit, opts.Offset)
}
// Expand query, because some of the args might be an array
query, args, err := sqlx.In(query, args...)
if err != nil {
return nil, fmt.Errorf("failed to execute select query for tags: %w", err)
}
// Fetch bookmarks
bookmarks := []model.BookmarkDTO{}
err = db.reader.SelectContext(ctx, &bookmarks, query, args...)
if err != nil && err != sql.ErrNoRows {
return nil, fmt.Errorf("failed to fetch accounts: %w", err)
}
// store bookmark IDs for further enrichment
var bookmarkIds = make([]int, 0, len(bookmarks))
for _, book := range bookmarks {
bookmarkIds = append(bookmarkIds, book.ID)
}
if len(bookmarkIds) == 0 {
return bookmarks, nil
}
// If content needed, fetch it separately
// It's faster than join with virtual table
if opts.WithContent {
contents := make([]bookmarkContent, 0, len(bookmarks))
contentMap := make(map[int]bookmarkContent, len(bookmarks))
contentQuery, args, err := sqlx.In(`SELECT docid, content, html FROM bookmark_content WHERE docid IN (?)`, bookmarkIds)
contentQuery = db.reader.Rebind(contentQuery)
if err != nil {
return nil, fmt.Errorf("failed to expand tags query with IN clause: %w", err)
}
err = db.reader.Select(&contents, contentQuery, args...)
if err != nil && err != sql.ErrNoRows {
return nil, fmt.Errorf("failed to get tags: %w", err)
}
for _, content := range contents {
contentMap[content.ID] = content
}
for i := range bookmarks[:] {
book := &bookmarks[i]
if bookmarkContent, found := contentMap[book.ID]; found {
book.Content = bookmarkContent.Content
book.HTML = bookmarkContent.HTML
} else {
log.Printf("not found content for bookmark %d, but it should be; check DB consistency", book.ID)
}
}
}
// Fetch tags for each bookmark
tags := make([]tagContent, 0, len(bookmarks))
tagsMap := make(map[int][]model.TagDTO, len(bookmarks))
tagsQuery, tagArgs, err := sqlx.In(`SELECT bt.bookmark_id, t.id, t.name
FROM bookmark_tag bt
LEFT JOIN tag t ON bt.tag_id = t.id
WHERE bt.bookmark_id IN (?)
ORDER BY t.name`, bookmarkIds)
tagsQuery = db.reader.Rebind(tagsQuery)
if err != nil {
return nil, fmt.Errorf("failed to delete bookmark and related records: %w", err)
}
err = db.reader.Select(&tags, tagsQuery, tagArgs...)
if err != nil && err != sql.ErrNoRows {
return nil, fmt.Errorf("failed to get tags: %w", err)
}
for _, fetchedTag := range tags {
if tags, found := tagsMap[fetchedTag.ID]; found {
tagsMap[fetchedTag.ID] = append(tags, fetchedTag.Tag.ToDTO())
} else {
tagsMap[fetchedTag.ID] = []model.TagDTO{fetchedTag.Tag.ToDTO()}
}
}
for i := range bookmarks[:] {
book := &bookmarks[i]
if tags, found := tagsMap[book.ID]; found {
book.Tags = tags
} else {
book.Tags = []model.TagDTO{}
}
}
return bookmarks, nil
}
// GetBookmarksCount fetch count of bookmarks based on submitted options.
func (db *SQLiteDatabase) GetBookmarksCount(ctx context.Context, opts model.DBGetBookmarksOptions) (int, error) {
// Create initial query
query := `SELECT COUNT(b.id)
FROM bookmark b
WHERE 1`
// Add where clause
args := []interface{}{}
// Add where clause for IDs
if len(opts.IDs) > 0 {
query += ` AND b.id IN (?)`
args = append(args, opts.IDs)
}
// Add where clause for search keyword
if opts.Keyword != "" {
query += ` AND (b.url LIKE '%' || ? || '%' OR b.excerpt LIKE '%' || ? || '%' OR b.id IN (
SELECT docid id
FROM bookmark_content
WHERE title MATCH ? OR content MATCH ?))`
args = append(args, opts.Keyword, opts.Keyword)
// Replace dash with spaces since FTS5 uses `-name` as column identifier and double quote
// since FTS5 uses double quote as string identifier
// Reference: https://sqlite.org/fts5.html#fts5_strings
ftsKeyword := strings.ReplaceAll(opts.Keyword, "-", " ")
// Properly set double quotes for string literals in sqlite's fts
ftsKeyword = strings.ReplaceAll(ftsKeyword, "\"", "\"\"")
args = append(args, "\""+ftsKeyword+"\"", "\""+ftsKeyword+"\"")
}
// Add where clause for tags.
// First we check for * in excluded and included tags,
// which means all tags will be excluded and included, respectively.
excludeAllTags := false
for _, excludedTag := range opts.ExcludedTags {
if excludedTag == "*" {
excludeAllTags = true
opts.ExcludedTags = []string{}
break
}
}
includeAllTags := false
for _, includedTag := range opts.Tags {
if includedTag == "*" {
includeAllTags = true
opts.Tags = []string{}
break
}
}
// If all tags excluded, we will only show bookmark without tags.
// In other hand, if all tags included, we will only show bookmark with tags.
if excludeAllTags {
query += ` AND b.id NOT IN (SELECT DISTINCT bookmark_id FROM bookmark_tag)`
} else if includeAllTags {
query += ` AND b.id IN (SELECT DISTINCT bookmark_id FROM bookmark_tag)`
}
// Now we only need to find the normal tags
if len(opts.Tags) > 0 {
query += ` AND b.id IN (
SELECT bt.bookmark_id
FROM bookmark_tag bt
LEFT JOIN tag t ON bt.tag_id = t.id
WHERE t.name IN(?)
GROUP BY bt.bookmark_id
HAVING COUNT(bt.bookmark_id) = ?)`
args = append(args, opts.Tags, len(opts.Tags))
}
if len(opts.ExcludedTags) > 0 {
query += ` AND b.id NOT IN (
SELECT DISTINCT bt.bookmark_id
FROM bookmark_tag bt
LEFT JOIN tag t ON bt.tag_id = t.id
WHERE t.name IN(?))`
args = append(args, opts.ExcludedTags)
}
// Expand query, because some of the args might be an array
query, args, err := sqlx.In(query, args...)
if err != nil {
return 0, fmt.Errorf("failed to expand query with IN clause: %w", err)
}
// Fetch count
var nBookmarks int
err = db.reader.GetContext(ctx, &nBookmarks, query, args...)
if err != nil && err != sql.ErrNoRows {
return 0, fmt.Errorf("failed to get bookmark count: %w", err)
}
return nBookmarks, nil
}
// DeleteBookmarks removes all record with matching ids from database.
func (db *SQLiteDatabase) DeleteBookmarks(ctx context.Context, ids ...int) error {
if err := db.withTx(ctx, func(tx *sqlx.Tx) error {
// Prepare queries
delBookmark := `DELETE FROM bookmark`
delBookmarkTag := `DELETE FROM bookmark_tag`
delBookmarkContent := `DELETE FROM bookmark_content`
// Delete bookmark(s)
if len(ids) == 0 {
_, err := tx.ExecContext(ctx, delBookmarkContent)
if err != nil {
return fmt.Errorf("failed to prepare delete statement: %w", err)
}
_, err = tx.ExecContext(ctx, delBookmarkTag)
if err != nil {
return fmt.Errorf("failed to execute delete account statement: %w", err)
}
_, err = tx.ExecContext(ctx, delBookmark)
if err != nil {
return fmt.Errorf("failed to execute delete bookmark statement: %w", err)
}
} else {
delBookmark += ` WHERE id = ?`
delBookmarkTag += ` WHERE bookmark_id = ?`
delBookmarkContent += ` WHERE docid = ?`
stmtDelBookmark, err := tx.Preparex(delBookmark)
if err != nil {
return fmt.Errorf("failed to get bookmark: %w", err)
}
stmtDelBookmarkTag, err := tx.Preparex(delBookmarkTag)
if err != nil {
return fmt.Errorf("failed to expand query with IN clause: %w", err)
}
stmtDelBookmarkContent, err := tx.Preparex(delBookmarkContent)
if err != nil {
return fmt.Errorf("failed to delete bookmark content: %w", err)
}
for _, id := range ids {
_, err = stmtDelBookmarkContent.ExecContext(ctx, id)
if err != nil {
return fmt.Errorf("failed to delete bookmark: %w", err)
}
_, err = stmtDelBookmarkTag.ExecContext(ctx, id)
if err != nil {
return fmt.Errorf("failed to delete bookmark tag: %w", err)
}
_, err = stmtDelBookmark.ExecContext(ctx, id)
if err != nil {
return fmt.Errorf("failed to delete bookmark: %w", err)
}
}
}
return nil
}); err != nil {
return fmt.Errorf("failed to update database schema version: %w", err)
}
return nil
}
// GetBookmark fetches bookmark based on its ID or URL.
// Returns the bookmark and boolean whether it's exist or not.
func (db *SQLiteDatabase) GetBookmark(ctx context.Context, id int, url string) (model.BookmarkDTO, bool, error) {
args := []interface{}{id}
query := `SELECT
b.id, b.url, b.title, b.excerpt, b.author, b.public, b.modified_at,
bc.content, bc.html, b.has_content, b.created_at
FROM bookmark b
LEFT JOIN bookmark_content bc ON bc.docid = b.id
WHERE b.id = ?`
if url != "" {
query += ` OR b.url = ?`
args = append(args, url)
}
book := model.BookmarkDTO{}
if err := db.reader.GetContext(ctx, &book, query, args...); err != nil && err != sql.ErrNoRows {
return book, false, fmt.Errorf("failed to get bookmark: %w", err)
}
return book, book.ID != 0, nil
}
// CreateAccount saves new account to database. Returns error if any happened.
func (db *SQLiteDatabase) CreateAccount(ctx context.Context, account model.Account) (*model.Account, error) {
var accountID int64
if err := db.withTx(ctx, func(tx *sqlx.Tx) error {
// Check if username already exists
var exists bool
err := tx.GetContext(ctx, &exists,
"SELECT EXISTS(SELECT 1 FROM account WHERE username = ?)",
account.Username)
if err != nil {
return fmt.Errorf("error checking username existence: %w", err)
}
if exists {
return ErrAlreadyExists
}
// Insert new account
query, err := tx.PrepareContext(ctx, `INSERT INTO account
(username, password, owner, config) VALUES (?, ?, ?, ?)
RETURNING id`)
if err != nil {
return fmt.Errorf("error preparing query: %w", err)
}
err = query.QueryRowContext(ctx,
account.Username, account.Password, account.Owner, account.Config).Scan(&accountID)
if err != nil {
return fmt.Errorf("error executing query: %w", err)
}
return nil
}); err != nil {
return nil, fmt.Errorf("error running transaction: %w", err)
}
account.ID = model.DBID(accountID)
return &account, nil
}
// UpdateAccount updates account in database.
func (db *SQLiteDatabase) UpdateAccount(ctx context.Context, account model.Account) error {
if account.ID == 0 {
return ErrNotFound
}
if err := db.withTx(ctx, func(tx *sqlx.Tx) error {
// Check if username already exists for a different account
var exists bool
err := tx.GetContext(ctx, &exists,
"SELECT EXISTS(SELECT 1 FROM account WHERE username = ? AND id != ?)",
account.Username, account.ID)
if err != nil {
return fmt.Errorf("error checking username existence: %w", err)
}
if exists {
return ErrAlreadyExists
}
// Update account
queryString := "UPDATE account SET username = ?, password = ?, owner = ?, config = ? WHERE id = ?"
updateQuery, err := tx.PrepareContext(ctx, queryString)
if err != nil {
return fmt.Errorf("error preparing query: %w", err)
}
result, err := updateQuery.ExecContext(ctx,
account.Username, account.Password, account.Owner, account.Config, account.ID)
if err != nil {
return fmt.Errorf("error executing query: %w", err)
}
rows, err := result.RowsAffected()
if err != nil {
return fmt.Errorf("error getting rows affected: %w", err)
}
if rows == 0 {
return ErrNotFound
}
return nil
}); err != nil {
return fmt.Errorf("error running transaction: %w", err)
}
return nil
}
// ListAccounts fetch list of account (without its password) based on submitted options.
func (db *SQLiteDatabase) ListAccounts(ctx context.Context, opts model.DBListAccountsOptions) ([]model.Account, error) {
// Create query
args := []interface{}{}
fields := []string{"id", "username", "owner", "config"}
if opts.WithPassword {
fields = append(fields, "password")
}
query := fmt.Sprintf(`SELECT %s FROM account WHERE 1`, strings.Join(fields, ", "))
if opts.Keyword != "" {
query += " AND username LIKE ?"
args = append(args, "%"+opts.Keyword+"%")
}
if opts.Username != "" {
query += " AND username = ?"
args = append(args, opts.Username)
}
if opts.Owner {
query += " AND owner = 1"
}
// Fetch list account
accounts := []model.Account{}
err := db.reader.SelectContext(ctx, &accounts, query, args...)
if err != nil && err != sql.ErrNoRows {
return nil, fmt.Errorf("failed to execute select query: %w", err)
}
return accounts, nil
}
// GetAccount fetch account with matching ID.
// Returns the account and boolean whether it's exist or not.
func (db *SQLiteDatabase) GetAccount(ctx context.Context, id model.DBID) (*model.Account, bool, error) {
account := model.Account{}
err := db.reader.GetContext(ctx, &account, `SELECT
id, username, password, owner, config FROM account WHERE id = ?`,
id,
)
if err != nil && err != sql.ErrNoRows {
return &account, false, errors.WithStack(err)
}
// Use custom not found error if that's the result of the query
if err == sql.ErrNoRows {
err = ErrNotFound
}
return &account, account.ID != 0, err
}
// DeleteAccount removes record with matching ID.
func (db *SQLiteDatabase) DeleteAccount(ctx context.Context, id model.DBID) error {
if err := db.withTx(ctx, func(tx *sqlx.Tx) error {
result, err := tx.ExecContext(ctx, `DELETE FROM account WHERE id = ?`, id)
if err != nil {
return errors.WithStack(fmt.Errorf("error deleting account: %v", err))
}
rows, err := result.RowsAffected()
if err != nil && err != sql.ErrNoRows {
return errors.WithStack(fmt.Errorf("error getting rows affected: %v", err))
}
if rows == 0 {
return ErrNotFound
}
return nil
}); err != nil {
return fmt.Errorf("failed to prepare statement: %w", err)
}
return nil
}
// CreateTags creates new tags from submitted objects.
func (db *SQLiteDatabase) CreateTags(ctx context.Context, tags ...model.Tag) error {
query := `INSERT INTO tag (name) VALUES `
values := []interface{}{}
for _, t := range tags {
query += "(?),"
values = append(values, t.Name)
}
query = query[0 : len(query)-1]
if err := db.withTx(ctx, func(tx *sqlx.Tx) error {
stmt, err := tx.Preparex(query)
if err != nil {
return fmt.Errorf("failed to prepare tag creation query: %w", err)
}
_, err = stmt.ExecContext(ctx, values...)
if err != nil {
return fmt.Errorf("failed to execute tag creation query: %w", err)
}
return nil
}); err != nil {
return fmt.Errorf("failed to run tag creation transaction: %w", err)
}
return nil
}
// GetTags fetch list of tags and their frequency.
func (db *SQLiteDatabase) GetTags(ctx context.Context) ([]model.TagDTO, error) {
tags := []model.TagDTO{}
query := `SELECT t.id, t.name, COUNT(bt.tag_id) bookmark_count
FROM tag t
LEFT JOIN bookmark_tag bt ON bt.tag_id = t.id
GROUP BY t.id ORDER BY t.name`
err := db.reader.SelectContext(ctx, &tags, query)
if err != nil && err != sql.ErrNoRows {
return nil, fmt.Errorf("failed to prepare delete bookmark content statement: %w", err)
}
return tags, nil
}
// RenameTag change the name of a tag.
func (db *SQLiteDatabase) RenameTag(ctx context.Context, id int, newName string) error {
if err := db.withTx(ctx, func(tx *sqlx.Tx) error {
_, err := tx.ExecContext(ctx, `UPDATE tag SET name = ? WHERE id = ?`, newName, id)
return err
}); err != nil {
return fmt.Errorf("failed to rename tag: %w", err)
}
return nil
}