2020-10-28 04:53:39 +01:00
|
|
|
# TabFS
|
2019-02-26 05:13:58 +01:00
|
|
|
|
|
|
|
## Setup
|
|
|
|
|
2020-10-30 07:54:40 +01:00
|
|
|
First, install the browser extension.
|
2019-02-26 05:13:58 +01:00
|
|
|
|
2020-10-30 07:54:40 +01:00
|
|
|
Then, install the C filesystem.
|
|
|
|
|
|
|
|
### Install the browser extension
|
|
|
|
|
|
|
|
(I think it will work on Edge or Opera or whatever, too. You'll need to
|
|
|
|
change the native messaging path in install.sh in those cases.)
|
|
|
|
|
|
|
|
#### Chrome
|
|
|
|
|
|
|
|
Go to the [Chrome extensions page](chrome://extensions). Enable
|
|
|
|
Developer mode (top-right corner).
|
|
|
|
|
|
|
|
Load-unpacked the `extension/` folder in this repo.
|
|
|
|
|
|
|
|
Get the extension ID.
|
|
|
|
|
|
|
|
#### Firefox
|
|
|
|
|
|
|
|
|
|
|
|
### Install the C filesystem
|
2019-02-26 05:13:58 +01:00
|
|
|
|
2020-10-24 07:47:59 +02:00
|
|
|
First, make sure you `git submodule update --init` to get the
|
|
|
|
`fs/cJSON` and `fs/base64` dependencies.
|
|
|
|
|
|
|
|
And make sure you have FUSE. On Linux, for example, `sudo apt install
|
|
|
|
libfuse-dev`. On macOS, get FUSE for macOS.
|
2019-02-26 05:13:58 +01:00
|
|
|
|
|
|
|
```
|
|
|
|
$ cd fs
|
|
|
|
$ mkdir mnt
|
2020-10-24 07:47:59 +02:00
|
|
|
$ make
|
2019-02-26 05:13:58 +01:00
|
|
|
```
|
|
|
|
|
2020-10-28 04:53:39 +01:00
|
|
|
Now install the native messaging host into your browser, so the
|
|
|
|
extension can launch and talk to the filesystem:
|
|
|
|
|
|
|
|
```
|
|
|
|
$ ./install.sh [chrome | chromium | firefox]
|
|
|
|
```
|
|
|
|
|
2020-10-30 07:54:40 +01:00
|
|
|
### Ready
|
2020-10-28 04:53:39 +01:00
|
|
|
|
2020-10-30 07:54:40 +01:00
|
|
|
Reload the extension in `chrome://extensions`.
|
2020-10-28 04:53:39 +01:00
|
|
|
|
2020-10-30 07:54:40 +01:00
|
|
|
Now your browser tabs should be mounted in `fs/mnt`!
|
2020-10-28 04:53:39 +01:00
|
|
|
|
2020-10-30 07:54:40 +01:00
|
|
|
## Examples of stuff you can do
|
2019-02-26 05:13:58 +01:00
|
|
|
|
2020-10-30 07:54:40 +01:00
|
|
|
(assuming your shell is in the `fs` subdirectory)
|
2019-02-26 05:13:58 +01:00
|
|
|
|
2020-10-30 07:54:40 +01:00
|
|
|
### List the titles of all the tabs you have open
|
2019-02-26 05:13:58 +01:00
|
|
|
|
2020-10-30 07:54:40 +01:00
|
|
|
```
|
|
|
|
$ cat mnt/tabs/by-id/*/title
|
|
|
|
GitHub
|
|
|
|
Extensions
|
|
|
|
TabFS/install.sh at master · osnr/TabFS
|
|
|
|
Alternative Extension Distribution Options - Google Chrome
|
|
|
|
Web Store Hosting and Updating - Google Chrome
|
|
|
|
Home / Twitter
|
|
|
|
...
|
|
|
|
```
|
|
|
|
|
|
|
|
### Close all Stack Overflow tabs
|
|
|
|
|
|
|
|
```
|
|
|
|
$ echo close | tee -a mnt/tabs/by-title/*Stack_Overflow*/control
|
|
|
|
```
|
|
|
|
|
|
|
|
### Save text of all tabs to a file
|
|
|
|
|
|
|
|
(wip, FIXME)
|
|
|
|
|
|
|
|
```
|
|
|
|
$ cat mnt/tabs/by-id/*/text > text.txt
|
|
|
|
```
|
2019-02-26 05:13:58 +01:00
|
|
|
|
|
|
|
## Design
|
|
|
|
|
|
|
|
- `extension/`: Browser extension, written in JS
|
|
|
|
- `fs/`: Native FUSE filesystem, written in C
|
2020-10-24 07:47:59 +02:00
|
|
|
- `tabfs.c`: Talks to FUSE, implements fs operations, talks to browser.
|
2019-02-26 05:13:58 +01:00
|
|
|
|
|
|
|
When you, say, `cat` a file in the tab filesystem:
|
|
|
|
|
|
|
|
1. `cat` makes something like a `read` syscall,
|
|
|
|
|
|
|
|
2. which goes to the FUSE kernel module which backs that filesystem,
|
|
|
|
|
|
|
|
3. FUSE forwards it to the `tabfs_read` implementation in our
|
|
|
|
userspace filesystem in `fs/tabfs.c`,
|
|
|
|
|
|
|
|
4. then `tabfs_read` rephrases the request as a JSON string and
|
2020-10-24 07:47:59 +02:00
|
|
|
forwards it to the browser extension over 'native messaging',
|
2019-02-26 05:13:58 +01:00
|
|
|
|
|
|
|
6. our browser extension in `extension/background.js` handles the
|
|
|
|
incoming message and calls the browser APIs to construct the data
|
|
|
|
for that synthetic file;
|
|
|
|
|
2020-10-24 07:47:59 +02:00
|
|
|
7. then the data gets sent back in a JSON native message to `tabfs.c`
|
|
|
|
and and finally back to FUSE and the kernel and `cat`.
|
2019-02-26 05:13:58 +01:00
|
|
|
|
|
|
|
(very little actual work happened here, tbh. it's all just
|
|
|
|
marshalling)
|
|
|
|
|
|
|
|
TODO: make diagrams?
|
2020-10-28 04:53:39 +01:00
|
|
|
|
2020-10-28 22:14:57 +01:00
|
|
|
## license
|
|
|
|
|
|
|
|
GPLv3
|
|
|
|
|
2020-10-28 04:53:39 +01:00
|
|
|
## hmm
|
|
|
|
|
|
|
|
it's way too hard to make an extension. even 'make an extension' is
|
|
|
|
a bad framing
|
|
|
|
|
|
|
|
open input space -- filesystem
|
|
|
|
|
|
|
|
now you have this whole 'language', this whole toolset, to control and
|
|
|
|
automate your browser
|
|
|
|
|
|
|
|
OSQuery
|
|
|
|
|
|
|
|
fake filesystems talk
|
|
|
|
|
|
|
|
Screenotate
|
|
|
|
|
|
|
|
processes as files. the real process is the browser.
|
|
|
|
|
|
|
|
browser and Unix
|
|
|
|
|
|
|
|
rmdir a non-empty directory
|