Chakib Ben Ziane
2370500250
- Refactoring - Inserting bookmarks to DBs now merges the tags - WIP sync strategy between buffer and cache - TODO: firefox index/buffer sync
384 lines
8.0 KiB
Go
384 lines
8.0 KiB
Go
//TODO: Handle modified time
|
|
package main
|
|
|
|
import (
|
|
"database/sql"
|
|
"errors"
|
|
"fmt"
|
|
"path/filepath"
|
|
|
|
sqlite3 "github.com/mattn/go-sqlite3"
|
|
)
|
|
|
|
// Global cache database
|
|
var (
|
|
CacheDB *DB // Main in memory db, is synced with disc
|
|
_sql3conns []*sqlite3.SQLiteConn // Only used for backup hook
|
|
backupHookRegistered bool // set to true once the backup hook is registered
|
|
)
|
|
|
|
const (
|
|
DB_FILENAME = "gomarks.db"
|
|
DBMemcacheFmt = "file:%s?mode=memory&cache=shared"
|
|
DBBufferFmt = "file:%s?mode=memory&cache=shared"
|
|
DB_BACKUP_HOOK = "sqlite_with_backup"
|
|
)
|
|
|
|
// Database schemas used for the creation of new databases
|
|
const (
|
|
// metadata: name or title of resource
|
|
QCreateLocalDbSchema = `CREATE TABLE if not exists bookmarks (
|
|
id integer PRIMARY KEY,
|
|
URL text NOT NULL UNIQUE,
|
|
metadata text default '',
|
|
tags text default '',
|
|
desc text default '',
|
|
modified integer default ?,
|
|
flags integer default 0
|
|
)`
|
|
|
|
QCreateMemDbSchema = `CREATE TABLE if not exists bookmarks (
|
|
id integer PRIMARY KEY,
|
|
URL text NOT NULL UNIQUE,
|
|
metadata text default '',
|
|
tags text default '',
|
|
desc text default '',
|
|
modified integer default (strftime('%s')),
|
|
flags integer default 0
|
|
)`
|
|
)
|
|
|
|
// DB encapsulates an sql.DB struct. All interactions with memory/buffer and
|
|
// disk databases are done through the DB object
|
|
type DB struct {
|
|
Name string
|
|
Path string
|
|
Handle *sql.DB
|
|
}
|
|
|
|
func (db DB) New(name string, path string) *DB {
|
|
return &DB{name, path, nil}
|
|
}
|
|
|
|
func (db *DB) Error() string {
|
|
errMsg := fmt.Sprintf("[error][db] name <%s>", db.Name)
|
|
return errMsg
|
|
}
|
|
|
|
// Initialize sqlite database for read only operations
|
|
func (db *DB) InitRO() {
|
|
var err error
|
|
|
|
if db.Handle != nil {
|
|
logErrorMsg(db, "already initialized")
|
|
return
|
|
}
|
|
|
|
// Create the sqlite connection
|
|
db.Handle, err = sql.Open("sqlite3", db.Path)
|
|
log.Debugf("<%s> opened at <%s>", db.Name, db.Path)
|
|
logPanic(err)
|
|
}
|
|
|
|
// Initialize a sqlite database with Gomark Schema
|
|
func (db *DB) Init() {
|
|
|
|
// TODO: Use context when making call from request/api
|
|
// `cacheDB` is a memory replica of disk db
|
|
|
|
var err error
|
|
|
|
if db.Handle != nil {
|
|
logErrorMsg(db, "already initialized")
|
|
return
|
|
}
|
|
|
|
// Create the memory cache db
|
|
db.Handle, err = sql.Open("sqlite3", db.Path)
|
|
//log.Debugf("db <%s> opend at at <%s>", db.name, db.path)
|
|
log.Debugf("<%s> opened at <%s>", db.Name, db.Path)
|
|
logPanic(err)
|
|
|
|
// Populate db schema
|
|
tx, err := db.Handle.Begin()
|
|
logPanic(err)
|
|
|
|
stmt, err := tx.Prepare(QCreateMemDbSchema)
|
|
logPanic(err)
|
|
|
|
_, err = stmt.Exec()
|
|
logPanic(err)
|
|
|
|
err = tx.Commit()
|
|
logPanic(err)
|
|
|
|
if !backupHookRegistered {
|
|
//log.Debugf("backup_hook: registering driver %s", DB_BACKUP_HOOK)
|
|
// Register the hook
|
|
sql.Register(DB_BACKUP_HOOK,
|
|
&sqlite3.SQLiteDriver{
|
|
ConnectHook: func(conn *sqlite3.SQLiteConn) error {
|
|
//log.Debugf("[HOOK] registering new connection")
|
|
_sql3conns = append(_sql3conns, conn)
|
|
//log.Debugf("%v", _sql3conns)
|
|
return nil
|
|
},
|
|
})
|
|
backupHookRegistered = true
|
|
}
|
|
|
|
log.Debugf("<%s> initialized", db.Name)
|
|
}
|
|
|
|
func (db *DB) Attach(attached *DB) {
|
|
|
|
stmtStr := fmt.Sprintf("ATTACH DATABASE '%s' AS '%s'", attached.Path, attached.Name)
|
|
_, err := db.Handle.Exec(stmtStr)
|
|
logPanic(err)
|
|
|
|
/////////////////
|
|
// For debug only
|
|
/////////////////
|
|
//var idx int
|
|
//var dt string
|
|
//var name string
|
|
|
|
//rows, err := db.handle.Query("PRAGMA database_list;")
|
|
//logPanic(err)
|
|
//for rows.Next() {
|
|
//err = rows.Scan(&idx, &dt, &name)
|
|
//logPanic(err)
|
|
//log.Debugf("pragmalist: %s", dt)
|
|
//}
|
|
}
|
|
|
|
func (db *DB) Close() {
|
|
log.Debugf("Closing DB <%s>", db.Name)
|
|
db.Handle.Close()
|
|
}
|
|
|
|
func (db *DB) Count() int {
|
|
var count int
|
|
|
|
row := db.Handle.QueryRow("select count(*) from bookmarks")
|
|
err := row.Scan(&count)
|
|
logPanic(err)
|
|
|
|
return count
|
|
}
|
|
|
|
func (db *DB) Print() error {
|
|
|
|
var url string
|
|
|
|
rows, err := db.Handle.Query("select url from bookmarks")
|
|
|
|
for rows.Next() {
|
|
err = rows.Scan(&url)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
log.Debugf("%s", url)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (db *DB) isEmpty() (bool, error) {
|
|
var count int
|
|
|
|
row := db.Handle.QueryRow("select count(*) from bookmarks")
|
|
|
|
err := row.Scan(&count)
|
|
if err != nil {
|
|
return false, err
|
|
}
|
|
|
|
if count > 0 {
|
|
return false, nil
|
|
}
|
|
|
|
return true, nil
|
|
}
|
|
|
|
// For ever row in `src` try to insert it into `dst`.
|
|
// If if fails then try to update it. It means `src` is synced to `dst`
|
|
func (src *DB) SyncTo(dst *DB) {
|
|
var sqlite3Err sqlite3.Error
|
|
|
|
getSourceTable, err := src.Handle.Prepare(`SELECT * FROM bookmarks`)
|
|
defer getSourceRows.Close()
|
|
logPanic(err)
|
|
|
|
updateDstTable, err := dst.Handle.Prepare(`INSERT INTO
|
|
bookmarks(URL, metadata, tags, desc,
|
|
flags) VALUES (?, ?, ?, ?, ?)`)
|
|
|
|
}
|
|
|
|
// Copy from src DB to dst DB
|
|
// Source DB os overwritten
|
|
func (src *DB) CopyTo(dst *DB) {
|
|
|
|
log.Debugf("Copying <%s>(%d) to <%s>(%d)", src.Name,
|
|
src.Count(),
|
|
dst.Name,
|
|
dst.Count())
|
|
|
|
srcDb, err := sql.Open(DB_BACKUP_HOOK, src.Path)
|
|
defer func() {
|
|
srcDb.Close()
|
|
_sql3conns = _sql3conns[:len(_sql3conns)-1]
|
|
}()
|
|
logPanic(err)
|
|
|
|
srcDb.Ping()
|
|
|
|
dstDb, err := sql.Open(DB_BACKUP_HOOK, dst.Path)
|
|
defer func() {
|
|
dstDb.Close()
|
|
_sql3conns = _sql3conns[:len(_sql3conns)-1]
|
|
}()
|
|
logPanic(err)
|
|
dstDb.Ping()
|
|
|
|
bk, err := _sql3conns[1].Backup("main", _sql3conns[0], "main")
|
|
logPanic(err)
|
|
|
|
_, err = bk.Step(-1)
|
|
logPanic(err)
|
|
|
|
bk.Finish()
|
|
}
|
|
|
|
func (src *DB) SyncToDisk(dbpath string) error {
|
|
log.Debugf("Syncing <%s> to <%s>", src.Name, dbpath)
|
|
|
|
if !backupHookRegistered {
|
|
errMsg := fmt.Sprintf("%s, %s", src.Path, "db backup hook is not initialized")
|
|
return errors.New(errMsg)
|
|
}
|
|
|
|
//log.Debugf("[flush] openeing <%s>", src.path)
|
|
srcDb, err := sql.Open(DB_BACKUP_HOOK, src.Path)
|
|
defer flushSqliteCon(srcDb)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
srcDb.Ping()
|
|
|
|
//log.Debugf("[flush] opening <%s>", DB_FILENAME)
|
|
|
|
dbUri := fmt.Sprintf("file:%s", dbpath)
|
|
bkDb, err := sql.Open(DB_BACKUP_HOOK, dbUri)
|
|
defer flushSqliteCon(bkDb)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
bkDb.Ping()
|
|
|
|
bk, err := _sql3conns[1].Backup("main", _sql3conns[0], "main")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
_, err = bk.Step(-1)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
bk.Finish()
|
|
|
|
return nil
|
|
}
|
|
|
|
func (dst *DB) SyncFromDisk(dbpath string) error {
|
|
|
|
if !backupHookRegistered {
|
|
errMsg := fmt.Sprintf("%s, %s", dst.Path, "db backup hook is not initialized")
|
|
return errors.New(errMsg)
|
|
}
|
|
|
|
log.Debugf("Syncing <%s> to <%s>", dbpath, dst.Name)
|
|
|
|
dbUri := fmt.Sprintf("file:%s", dbpath)
|
|
srcDb, err := sql.Open(DB_BACKUP_HOOK, dbUri)
|
|
defer flushSqliteCon(srcDb)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
srcDb.Ping()
|
|
|
|
//log.Debugf("[flush] opening <%s>", DB_FILENAME)
|
|
bkDb, err := sql.Open(DB_BACKUP_HOOK, dst.Path)
|
|
defer flushSqliteCon(bkDb)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
bkDb.Ping()
|
|
|
|
bk, err := _sql3conns[1].Backup("main", _sql3conns[0], "main")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
_, err = bk.Step(-1)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
bk.Finish()
|
|
|
|
return nil
|
|
}
|
|
|
|
// TODO: Use context when making call from request/api
|
|
func initDB() {
|
|
|
|
// Initialize memory db with schema
|
|
cacheName := "memcache"
|
|
cachePath := fmt.Sprintf(DBMemcacheFmt, cacheName)
|
|
CacheDB = DB{}.New(cacheName, cachePath)
|
|
CacheDB.Init()
|
|
|
|
// Check and initialize local db as last step
|
|
// browser bookmarks should already be in cache
|
|
|
|
dbdir := getDefaultDBPath()
|
|
dbpath := filepath.Join(dbdir, DB_FILENAME)
|
|
|
|
// Verifiy that local db directory path is writeable
|
|
err := checkWriteable(dbdir)
|
|
logPanic(err)
|
|
|
|
// If local db exists load it to cacheDB
|
|
var exists bool
|
|
if exists, err = checkFileExists(dbpath); exists {
|
|
logPanic(err)
|
|
log.Debugf("localdb exists, preloading to cache")
|
|
CacheDB.SyncFromDisk(dbpath)
|
|
//_ = cacheDB.Print()
|
|
} else {
|
|
logPanic(err)
|
|
// Else initialize it
|
|
initLocalDB(CacheDB, dbpath)
|
|
}
|
|
|
|
}
|
|
|
|
//Initialize the local database file
|
|
func initLocalDB(db *DB, dbpath string) {
|
|
|
|
log.Infof("Initializing local db at '%s'", dbpath)
|
|
log.Debugf("%s flushing to disk", db.Name)
|
|
err := db.SyncToDisk(dbpath)
|
|
logPanic(err)
|
|
|
|
}
|
|
|
|
func flushSqliteCon(con *sql.DB) {
|
|
con.Close()
|
|
_sql3conns = _sql3conns[:len(_sql3conns)-1]
|
|
log.Debugf("Flushed sqlite conns %v", _sql3conns)
|
|
}
|