mangadex-fs 0.2.0-beta.1

FUSE driver using MangaDex API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# mangadex-fs [![crates.io](https://img.shields.io/crates/v/mangadex-fs?style=flat-square)](https://crates.io/crates/mangadex-fs)

_FUSE driver for your weeb needs._ 

This is a basic implementation of FUSE driver utilising [MangaDex](https://mangadex.org/) undocumented API. Manga information, chapters and individual pages are cached in memory so repeated requests don't accidently DDOS the server.

---

### Version 0.2.0-beta

If you're looking for some _previously_ working code, check out [previous version](https://github.com/bittersweetshimmer/mangadex-fs/tree/v0.1.5). I think it no longer works though.

---

## Usage

There are 2 binaries now, the client `mangadex-fsc` and the daemon `mangadex-fsd`.

1. `cargo install mangadex-fs` (or clone this repo),
2. checkout `mangadex-fsc --help` / `mangadex-fsd --help` (or `cargo run --release --bin mangadex-fsc -- --help`) on how to use,
3. please **don't abuse** MangaDex server, use with consideration,
4. have fun reading.  

Short example:
```console
urmom@gay ~> mkdir ~/Manga
urmom@gay ~> mangadex-fsd ~/Manga
```
```console
urmom@gay ~> mangadex-fsc login -u <username> -p <password>
OK
urmom@gay ~> mangadex-fsc quicksearch "Made In Abyss"
16482 Made in Abyss
38973 Made in Abyss Official Anthology
47082 Made in Abyss 47.X: Welcome Back
31677 Made In Abyss (Fan Colored)
OK
me@urmom ~> mangadex-fsc add manga 16482
Manga Made in Abyss has been added.
OK
```

### Notes

-   You need to have FUSE installed, and its kernel module loaded: `modprobe fuse`.
-   This version doesn't support any sort of API throttling/debouncing. For now.
-   Since fetching only the chapter page image size no longer works (`curl -I image_url` returns `405`), every time your system issues a `readdir` call (basically `ls`) on a chapter directory, every image gets fetched in its entirety. You can imagine it can take some time. Also MangaDex servers get buried in requests.

    So if you're calling `tree` on the mountpoint directory, you are basically asking for an IP ban.
    
    This can also happen if you're using some fancy command line shells, be wary. `bash` looks safe.
-   API responses are cached, and there is no command for fetching updates currently.
-   ```sh
    cd <mountpoint>/<manga>/<chapter>
    ls -1a | xargs -d '\n' feh --image-bg "black" -Z -. -d -S filename --version-sort
    ```

    creates a good reader. Obviously you need to have [`feh`](https://github.com/derf/feh) installed.
-   You can enable logging by setting `RUST_LOG` environment variable. More [here](https://docs.rs/env_logger/0.7.0/env_logger/).
-   If you encounter a `socket error: Address already in use (os error 98)`, it means the socket file is still present in the runtime directory, you can remove it with `rm $XDG_RUNTIME_DIR/mangadex-fs/mangadex-fsd.sock`.
-   You can place a configuration file in `$XDG_CONFIG_HOME/mangadex-fs/config.toml`. It can be only provided with the socket file path for now, so it's mostly useless:
```toml
socket = "/run/user/1000/mangadex-fs/mangadex-fsd.sock"
```

-   >Your code is a dumpster fire

    I bet! This is my first time using Rust for something more complicated than _Hello world_. If you have any guidelines or want to contribute go ahead, any help would be appreciated. With all these mutexes flying around I have no idea what I'm doing.