feat: refactor logger to standard library (#280)

* refactor: Refactor logging to use structured slog package.

- Remove `gookit` dependencies from `go.sum`
- Improve error logging in multiple packages by replacing `log` with `log/slog`
- Update dependencies in `go.mod`
- Add new `logger` package with test cases
- Refactor logging statements in multiple packages to use `slog` instead of `log`
- Change logging format and level in multiple packages for better structured logging

* refactor: Refactor logger package and add handler interface

- Refactor logger package
- Rename `defaultHandler` to `DefaultLogger`
- Move `ReplaceAttr` function to `Logger` struct
- Implement `LogHandler` struct with `slog.Handler` interface
- Add new `Logger` methods for configuration
- Add `SetMaxLevel`, `SetJSONHandler`, `SetTextHandler`, `SetOutput`, `SetVerbose`, `SetReplaceAttrFunc`
- Add verbose flag to `cmd/hack-browser-data/main.go` to increase logging

* refactor: Refactor logger package to use simplified handler initialization.

- Refactor logger package to use Default instead of DefaultLogger
- Update `NewHandler` method to correctly reference `Default` logger and simplify handler initialization
- Update tests for logger to reflect changes in Default usage
- Rename `DefaultLogger` to `Default` and update comments to better reflect its purpose
- Update function calls in hack-browser-data main.go to reflect logger package updates

* refactor: Refactor logging in Chromium implementation

Refactor logging and simplify decryption in chromium files
- Replace logger package import with shared slog package
- Change logging messages to use slog instead of logger
- Simplify decryption process by removing first 5 characters of encrypted key
- Refactor error logging in linux file to use shared slog package
- Replace string concatenation with formatted string in linux error message

Author: moonD4rk

README.md

@@ -5,7 +5,7 @@
 
 # HackBrowserData
 
-[![Lint](https://github.com/moonD4rk/HackBrowserData/actions/workflows/lint.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/lint.yml) [![build](https://github.com/moonD4rk/HackBrowserData/actions/workflows/build.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/build.yml) [![Release](https://github.com/moonD4rk/HackBrowserData/actions/workflows/release.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/release.yml) [![run tests](https://github.com/moonD4rk/HackBrowserData/actions/workflows/unittest.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/unittest.yml) [![Coverage Status](https://coveralls.io/repos/github/moonD4rk/HackBrowserData/badge.svg)](https://coveralls.io/github/moonD4rk/HackBrowserData)
+[![Lint](https://github.com/moonD4rk/HackBrowserData/actions/workflows/lint.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/lint.yml) [![build](https://github.com/moonD4rk/HackBrowserData/actions/workflows/build.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/build.yml) [![Release](https://github.com/moonD4rk/HackBrowserData/actions/workflows/release.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/release.yml) [![unit tests](https://github.com/moonD4rk/HackBrowserData/actions/workflows/unittest.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/unittest.yml) [![Coverage Status](https://coveralls.io/repos/github/moonD4rk/HackBrowserData/badge.svg?branch=main)](https://coveralls.io/github/moonD4rk/HackBrowserData?branch=main)
 
 [中文说明](https://github.com/moonD4rk/HackBrowserData/blob/master/README_ZH.md)
 
@@ -90,7 +90,7 @@ Installation of `HackBrowserData` is dead-simple, just download [the release for
 
 ### Building from source
 
-only support `go 1.18+` with go generics
+only support `go 1.21+` with go generics and log/slog standard library.
 
 ```bash
 $ git clone https://github.com/moonD4rk/HackBrowserData

browser/browser.go

@@ -1,14 +1,14 @@
 package browser
 
 import (
+	"log/slog"
 	"path/filepath"
 	"sort"
 	"strings"
 
 	"github.com/moond4rk/hackbrowserdata/browser/chromium"
 	"github.com/moond4rk/hackbrowserdata/browser/firefox"
 	"github.com/moond4rk/hackbrowserdata/browsingdata"
-	"github.com/moond4rk/hackbrowserdata/log"
 	"github.com/moond4rk/hackbrowserdata/utils/fileutil"
 	"github.com/moond4rk/hackbrowserdata/utils/typeutil"
 )
@@ -44,16 +44,16 @@ func pickChromium(name, profile string) []Browser {
 	if name == "all" {
 		for _, v := range chromiumList {
 			if !fileutil.IsDirExists(filepath.Clean(v.profilePath)) {
-				log.Noticef("find browser %s failed, profile folder does not exist", v.name)
+				slog.Warn("find browser failed, profile folder does not exist", "browser", v.name)
 				continue
 			}
 			multiChromium, err := chromium.New(v.name, v.storage, v.profilePath, v.items)
 			if err != nil {
-				log.Errorf("new chromium error: %v", err)
+				slog.Error("new chromium error", "err", err)
 				continue
 			}
 			for _, b := range multiChromium {
-				log.Noticef("find browser %s success", b.Name())
+				slog.Warn("find browser success", "browser", b.Name())
 				browsers = append(browsers, b)
 			}
 		}
@@ -63,14 +63,14 @@ func pickChromium(name, profile string) []Browser {
 			profile = c.profilePath
 		}
 		if !fileutil.IsDirExists(filepath.Clean(profile)) {
-			log.Fatalf("find browser %s failed, profile folder does not exist", c.name)
+			slog.Error("find browser failed, profile folder does not exist", "browser", c.name)
 		}
 		chromiumList, err := chromium.New(c.name, c.storage, profile, c.items)
 		if err != nil {
-			log.Fatalf("new chromium error: %s", err)
+			slog.Error("new chromium error", "err", err)
 		}
 		for _, b := range chromiumList {
-			log.Noticef("find browser %s success", b.Name())
+			slog.Warn("find browser success", "browser", b.Name())
 			browsers = append(browsers, b)
 		}
 	}
@@ -89,17 +89,17 @@ func pickFirefox(name, profile string) []Browser {
 			}
 
 			if !fileutil.IsDirExists(filepath.Clean(profile)) {
-				log.Noticef("find browser firefox %s failed, profile folder does not exist", v.name)
+				slog.Warn("find browser failed, profile folder does not exist", "browser", v.name)
 				continue
 			}
 
 			if multiFirefox, err := firefox.New(profile, v.items); err == nil {
 				for _, b := range multiFirefox {
-					log.Noticef("find browser firefox %s success", b.Name())
+					slog.Warn("find browser success", "browser", b.Name())
 					browsers = append(browsers, b)
 				}
 			} else {
-				log.Error(err)
+				slog.Error("new firefox error", "err", err)
 			}
 		}
 

browser/chromium/chromium.go

@@ -2,12 +2,12 @@ package chromium
 
 import (
 	"io/fs"
+	"log/slog"
 	"path/filepath"
 	"strings"
 
 	"github.com/moond4rk/hackbrowserdata/browsingdata"
 	"github.com/moond4rk/hackbrowserdata/item"
-	"github.com/moond4rk/hackbrowserdata/log"
 	"github.com/moond4rk/hackbrowserdata/utils/fileutil"
 	"github.com/moond4rk/hackbrowserdata/utils/typeutil"
 )
@@ -90,7 +90,7 @@ func (c *Chromium) copyItemToLocal() error {
 			err = fileutil.CopyFile(path, filename)
 		}
 		if err != nil {
-			log.Errorf("copy %s to %s error: %v", path, filename, err)
+			slog.Error("copy item to local error", "path", path, "filename", filename, "err", err)
 			continue
 		}
 	}

browser/chromium/chromium_darwin.go

@@ -7,14 +7,14 @@ import (
 	"crypto/sha1"
 	"errors"
 	"fmt"
+	"log/slog"
 	"os"
 	"os/exec"
 	"strings"
 
 	"golang.org/x/crypto/pbkdf2"
 
 	"github.com/moond4rk/hackbrowserdata/item"
-	"github.com/moond4rk/hackbrowserdata/log"
 )
 
 var (
@@ -55,6 +55,6 @@ func (c *Chromium) GetMasterKey() ([]byte, error) {
 		return nil, errWrongSecurityCommand
 	}
 	c.masterKey = key
-	log.Infof("%s initialized master key success", c.name)
+	slog.Info("get master key success", "browser", c.name)
 	return key, nil
 }

browser/chromium/chromium_linux.go

@@ -5,14 +5,14 @@ package chromium
 import (
 	"crypto/sha1"
 	"fmt"
+	"log/slog"
 	"os"
 
 	"github.com/godbus/dbus/v5"
 	keyring "github.com/ppacher/go-dbus-keyring"
 	"golang.org/x/crypto/pbkdf2"
 
 	"github.com/moond4rk/hackbrowserdata/item"
-	"github.com/moond4rk/hackbrowserdata/log"
 )
 
 func (c *Chromium) GetMasterKey() ([]byte, error) {
@@ -34,7 +34,7 @@ func (c *Chromium) GetMasterKey() ([]byte, error) {
 	}
 	defer func() {
 		if err := session.Close(); err != nil {
-			log.Errorf("close session failed: %v", err)
+			slog.Error("close dbus session error", "err", err.Error())
 		}
 	}()
 	collections, err := svc.GetAllCollections()
@@ -50,7 +50,7 @@ func (c *Chromium) GetMasterKey() ([]byte, error) {
 		for _, i := range items {
 			label, err := i.GetLabel()
 			if err != nil {
-				log.Error(err)
+				slog.Warn("get label from dbus", "err", err.Error())
 				continue
 			}
 			if label == c.storage {
@@ -71,6 +71,6 @@ func (c *Chromium) GetMasterKey() ([]byte, error) {
 	// @https://source.chromium.org/chromium/chromium/src/+/master:components/os_crypt/os_crypt_linux.cc
 	key := pbkdf2.Key(secret, salt, 1, 16, sha1.New)
 	c.masterKey = key
-	log.Infof("%s initialized master key success", c.name)
+	slog.Info("get master key success", "browser", c.name)
 	return key, nil
 }

browser/chromium/chromium_windows.go

@@ -5,13 +5,13 @@ package chromium
 import (
 	"encoding/base64"
 	"errors"
+	"log/slog"
 	"os"
 
 	"github.com/tidwall/gjson"
 
 	"github.com/moond4rk/hackbrowserdata/crypto"
 	"github.com/moond4rk/hackbrowserdata/item"
-	"github.com/moond4rk/hackbrowserdata/log"
 	"github.com/moond4rk/hackbrowserdata/utils/fileutil"
 )
 
@@ -35,9 +35,9 @@ func (c *Chromium) GetMasterKey() ([]byte, error) {
 	}
 	c.masterKey, err = crypto.DPAPI(key[5:])
 	if err != nil {
-		log.Errorf("%s failed to decrypt master key, maybe this profile was created on a different OS installation", c.name)
+		slog.Error("decrypt master key failed", "err", err)
 		return nil, err
 	}
-	log.Infof("%s initialized master key success", c.name)
+	slog.Info("get master key success", "browser", c.name)
 	return c.masterKey, nil
 }

browsingdata/bookmark/bookmark.go

@@ -2,6 +2,7 @@ package bookmark
 
 import (
 	"database/sql"
+	"log/slog"
 	"os"
 	"sort"
 	"time"
@@ -11,7 +12,6 @@ import (
 	"github.com/tidwall/gjson"
 
 	"github.com/moond4rk/hackbrowserdata/item"
-	"github.com/moond4rk/hackbrowserdata/log"
 	"github.com/moond4rk/hackbrowserdata/utils/fileutil"
 	"github.com/moond4rk/hackbrowserdata/utils/typeutil"
 )
@@ -102,7 +102,7 @@ func (f *FirefoxBookmark) Parse(_ []byte) error {
 	defer db.Close()
 	_, err = db.Exec(closeJournalMode)
 	if err != nil {
-		log.Error(err)
+		slog.Error("close journal mode error", "err", err)
 	}
 	rows, err := db.Query(queryFirefoxBookMark)
 	if err != nil {
@@ -115,7 +115,7 @@ func (f *FirefoxBookmark) Parse(_ []byte) error {
 			title, url        string
 		)
 		if err = rows.Scan(&id, &url, &bt, &dateAdded, &title); err != nil {
-			log.Warn(err)
+			slog.Error("scan bookmark error", "err", err)
 		}
 		*f = append(*f, bookmark{
 			ID:        id,

browsingdata/browsingdata.go

@@ -1,7 +1,7 @@
 package browsingdata
 
 import (
-	"path"
+	"log/slog"
 
 	"github.com/moond4rk/hackbrowserdata/browsingdata/bookmark"
 	"github.com/moond4rk/hackbrowserdata/browsingdata/cookie"
@@ -13,7 +13,6 @@ import (
 	"github.com/moond4rk/hackbrowserdata/browsingdata/password"
 	"github.com/moond4rk/hackbrowserdata/browsingdata/sessionstorage"
 	"github.com/moond4rk/hackbrowserdata/item"
-	"github.com/moond4rk/hackbrowserdata/log"
 	"github.com/moond4rk/hackbrowserdata/utils/fileutil"
 )
 
@@ -40,7 +39,7 @@ func New(items []item.Item) *Data {
 func (d *Data) Recovery(masterKey []byte) error {
 	for _, source := range d.sources {
 		if err := source.Parse(masterKey); err != nil {
-			log.Errorf("parse %s error %s", source.Name(), err.Error())
+			slog.Error("parse error", "source_data", source.Name(), "err", err.Error())
 			continue
 		}
 	}
@@ -59,18 +58,18 @@ func (d *Data) Output(dir, browserName, flag string) {
 
 		f, err := output.CreateFile(dir, filename)
 		if err != nil {
-			log.Errorf("create file %s error %s", filename, err.Error())
+			slog.Error("create file error", "filename", filename, "err", err.Error())
 			continue
 		}
 		if err := output.Write(source, f); err != nil {
-			log.Errorf("write to file %s error %s", filename, err.Error())
+			slog.Error("write to file error", "filename", filename, "err", err.Error())
 			continue
 		}
 		if err := f.Close(); err != nil {
-			log.Errorf("close file %s error %s", filename, err.Error())
+			slog.Error("close file error", "filename", filename, "err", err.Error())
 			continue
 		}
-		log.Noticef("output to file %s success", path.Join(dir, filename))
+		slog.Warn("export success", "filename", filename)
 	}
 }
 

browsingdata/cookie/cookie.go

@@ -2,6 +2,7 @@ package cookie
 
 import (
 	"database/sql"
+	"log/slog"
 	"os"
 	"sort"
 	"time"
@@ -11,7 +12,6 @@ import (
 
 	"github.com/moond4rk/hackbrowserdata/crypto"
 	"github.com/moond4rk/hackbrowserdata/item"
-	"github.com/moond4rk/hackbrowserdata/log"
 	"github.com/moond4rk/hackbrowserdata/utils/typeutil"
 )
 
@@ -55,7 +55,7 @@ func (c *ChromiumCookie) Parse(masterKey []byte) error {
 			value, encryptValue                           []byte
 		)
 		if err = rows.Scan(&key, &encryptValue, &host, &path, &createDate, &expireDate, &isSecure, &isHTTPOnly, &hasExpire, &isPersistent); err != nil {
-			log.Warn(err)
+			slog.Error("scan chromium cookie error", "err", err)
 		}
 
 		cookie := cookie{
@@ -77,7 +77,7 @@ func (c *ChromiumCookie) Parse(masterKey []byte) error {
 				value, err = crypto.DecryptPass(masterKey, encryptValue)
 			}
 			if err != nil {
-				log.Error(err)
+				slog.Error("decrypt chromium cookie error", "err", err)
 			}
 		}
 		cookie.Value = string(value)
@@ -123,7 +123,7 @@ func (f *FirefoxCookie) Parse(_ []byte) error {
 			creationTime, expiry    int64
 		)
 		if err = rows.Scan(&name, &value, &host, &path, &creationTime, &expiry, &isSecure, &isHTTPOnly); err != nil {
-			log.Warn(err)
+			slog.Error("scan firefox cookie error", "err", err)
 		}
 		*f = append(*f, cookie{
 			KeyName:    name,

browsingdata/creditcard/creditcard.go

@@ -2,14 +2,14 @@ package creditcard
 
 import (
 	"database/sql"
+	"log/slog"
 	"os"
 
 	// import sqlite3 driver
 	_ "github.com/mattn/go-sqlite3"
 
 	"github.com/moond4rk/hackbrowserdata/crypto"
 	"github.com/moond4rk/hackbrowserdata/item"
-	"github.com/moond4rk/hackbrowserdata/log"
 )
 
 type ChromiumCreditCard []card
@@ -47,7 +47,7 @@ func (c *ChromiumCreditCard) Parse(masterKey []byte) error {
 			value, encryptValue                        []byte
 		)
 		if err := rows.Scan(&guid, &name, &month, &year, &encryptValue, &address, &nickname); err != nil {
-			log.Warn(err)
+			slog.Error("scan chromium credit card error", "err", err)
 		}
 		ccInfo := card{
 			GUID:            guid,
@@ -64,7 +64,7 @@ func (c *ChromiumCreditCard) Parse(masterKey []byte) error {
 				value, err = crypto.DecryptPass(masterKey, encryptValue)
 			}
 			if err != nil {
-				log.Error(err)
+				slog.Error("decrypt chromium credit card error", "err", err)
 			}
 		}
 
@@ -102,7 +102,7 @@ func (c *YandexCreditCard) Parse(masterKey []byte) error {
 			value, encryptValue                        []byte
 		)
 		if err := rows.Scan(&guid, &name, &month, &year, &encryptValue, &address, &nickname); err != nil {
-			log.Warn(err)
+			slog.Error("scan chromium credit card error", "err", err)
 		}
 		ccInfo := card{
 			GUID:            guid,
@@ -119,7 +119,7 @@ func (c *YandexCreditCard) Parse(masterKey []byte) error {
 				value, err = crypto.DecryptPass(masterKey, encryptValue)
 			}
 			if err != nil {
-				log.Error(err)
+				slog.Error("decrypt chromium credit card error", "err", err)
 			}
 		}
 		ccInfo.CardNumber = string(value)