Some cleanups, minor functionality and README and LICENSE changes

Author: rxw1

Cargo.lock

@@ -30,6 +30,7 @@ dialoguer = "0.10.3"
 anyhow = "1.0.70"
 log = "0.4.17"
 pretty_env_logger = "0.4.0"
+env_logger = "0.10.0"
 
 [profile.release]
 codegen-units = 1 # reduce parallel code generation units

Cargo.toml

@@ -0,0 +1,123 @@
+Session Buddy Helper
+====================
+
+`Command line tool to do various things with your Session Buddy database`
+
+What
+----
+
+[Session Buddy](https://sessionbuddy.com/) is a Google Chrome [extension](https://chrome.google.com/webstore/detail/session-buddy/edacconmaakjimmfgnblocblbcdcpbko) to store and restore browser tabs. All its data is stored in a SQLite3 database. There is a Google Group where some discussion about Session Buddy takes place and, it seems, people sometimes lose their data or are having problems exporting or importing their stuff. This utility aims to do various operations on that database and help out those in need.
+
+Features
+--------
+
+* **Backup:** Create a JSON file similar to what the extension would do. The produced output is not exactly the same, but should be viable to be imported into Session Buddy again.
+
+* **Import:** Import a backup file created by either the extension or this tool into a database.
+
+* **Search:** Search your disk for Session Buddy databases. Sometimes it's a little bit cumbersome to figure out the path to the extension's database, so this should make things easier.
+
+* **New:** Create a new and empty Session Buddy database. It will have the same schema as when created by the extension.
+
+* **Debug:** Try to figure out if something is wrong with a database or a backup file.
+
+* **Stats:** Print various stats about a database. Useful to figure out what happened after executing some other task on the database.
+
+* **Dump:** Print all links to stdout.
+
+Current State & Motivation
+--------------------------
+
+So far it seems to work.
+
+Over the years I have aggregated multiple databases with in summary around 5,000 stored sessions consisting of around 15,000 windows and more than 130.0000 tabs. The extension would choke on exporting or just crash the extension or make the browser itself freeze. By doing all the stuff on the SQLite database itself, all that works.
+
+But still, it may be not advisable to carry all your stuff around in a Chrome extension all the time. By scheduling regular backups and pruning operations on the database Session Buddy probably won't lose it and, you have convenient (and performant) access to all your data.
+
+If you have any ideas or wishes regarding this tool or need help rescuing your thousands of tabs, feel free to reach out in the [discussions](https://github.com/rxw1/sbh/discussions).
+
+Installation
+------------
+
+```
+cargo install sbh
+```
+
+```
+git clone https://www.github.com/rxw1/sbh
+cd sbh
+cargo install --release .
+```
+
+```sh
+curl -LSfs https://japaric.github.io/trust/install.sh |\
+ sh -s -- --git rxw/sbh
+```
+
+Or download precompiled packages from [here](http://www.github.com/rxw1/sbh/releases).
+
+Usage Examples
+--------------
+
+### Search for databases
+
+Search for databases and print out the paths. By default, we're trying to figure out the proper path automatically depending on the operating system. For more information about these paths have a look at [dirs-rs](https://github.com/dirs-dev/dirs-rs).
+
+```
+sbh search
+```
+
+Or you can pass any path to search there:
+
+```
+sbh search ~/.config
+```
+
+### Backup a database to JSON
+
+```sh
+sbh backup -o whatever.json
+```
+
+If you do not specify an output file, the produced JSON will be printed to the standard output.
+
+### Search and backup each found database to a timestamped file
+
+```sh
+for db in "$(sbh search)"; do
+  o=sb-$(sbh id $db)-$(date +%Y%m%d%H%M%S).json
+  sbh backup -o $o $db
+  sbh validate backup $o
+done
+```
+
+### Dump sort and count all URLs stored in a database
+
+```sh
+sbh search | while read -r l; do
+  sbh dump "$l" | grep -Ev 'chrome(|-.*)://' | sort | uniq -c | sort -g
+done
+```
+
+TODO (Maybe)
+-----------
+
+* CSV export
+* Prune the database using certain criteria
+* Have config file to configure stuff
+* Handle `CurrentSession` and `PreviousSession` sessions
+
+Is it any good?
+---------------
+
+Yes, of course. It is written in Rust, and it's blazingly fast.
+
+Findings
+--------
+
+* For whatever reason, the JSON backups produced by the extension have `<feff>` as the first byte, i.e. a `BOM character` aka `Zero Width No-Break Space`, which breaks it for most parsers. I don't think having this in the beginning of a JSON file is a good thing. After removal, everything is fine. Here's some discussion about that on Stack Overflow: [https://stackoverflow.com/q/4990095/220472](https://stackoverflow.com/q/4990095/220472).
+
+Disclaimer
+----------
+
+Neither me or this tool is in any way affiliated with the developers of Session Buddy.

LICENSE

@@ -11,36 +11,28 @@ pub struct Args {
 
 #[derive(Subcommand, Debug)]
 pub enum Action {
-    /// Dump database to stdout
-    Dump {
-        /// Dump all URLs
-        #[arg()]
-        path: PathBuf
-    },
-
-    /// Print database statistics
-    Stats {
-        /// Path to search for databases
-        #[arg()]
-        path: PathBuf
-    },
-
-    /// Search for Session Buddy databases and print out their path
+    /// Search for databases and print out their path
     Search {
-        /// Path to search for databases
+        /// Path to search for databases. If no path argument is
+        /// given we're trying to figure it out.
         #[arg()]
         path: Option<PathBuf>
     },
 
     /// Create JSON backups from a Session Buddy database
     Backup {
+        /// Search for databases
+        //#[arg(conflicts_with = "path")]
+        //search: bool,
+
+        /// Output <FILENAME>
+        #[arg(short, long, value_name = "FILENAME")]
+        out: Option<PathBuf>,
+
         /// Database to backup
         #[arg(value_name = "DATABASE")]
         path: PathBuf,
 
-        /// Output <FILENAME>
-        #[arg(short, long, value_name = "FILENAME")]
-        out: Option<PathBuf>
     },
 
     /// Import JSON backups to a Session Buddy database
@@ -57,21 +49,51 @@ pub enum Action {
 
     /// Create a new database
     New {
+        /// Path to database
         #[arg()]
         path: PathBuf
     },
 
-    /// Various debug actions
-    Debug {
+    /// Print some database statistics
+    Stats {
+        /// Path to database
+        #[arg()]
+        path: PathBuf
+    },
+
+    /// Print all URLs of a database to stdout
+    Dump {
+        /// Path to database
+        #[arg()]
+        path: PathBuf
+    },
+
+
+    /// Print the id of a database
+    Id {
+        /// Path to database
+        #[arg()]
+        path: PathBuf
+    },
+
+    /// Validate a database or JSON backup
+    Validate {
         #[command(subcommand)]
-        action: DebugAction
-    }
+        action: ValidateAction
+    },
 }
 
 #[derive(Subcommand, Debug)]
-pub enum DebugAction {
+pub enum ValidateAction {
     Database {
+        /// Path to database
         #[arg()]
-        path: String
+        path: PathBuf
+    },
+
+    Backup {
+        /// Path to database
+        #[arg()]
+        path: PathBuf
     }
 }