# ofetch

**Repository Path**: iguojin/ofetch

## Basic Information

- **Project Name**: ofetch
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-04-17
- **Last Updated**: 2024-04-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## ofetch [![Build status](https://travis-ci.org/cfcs/ofetch.svg?branch=master)](https://travis-ci.org/cfcs/ofetch)

This is a HTTP client relying solely on the OCaml standard library.

The goal is to provide a dependency-free, safe utility to bootstrap
[opam](https://github.com/ocaml/opam), from where you can download a more
full-fletched HTTP client utilizing a more advanced parsing strategy.

It provides a [library](./ofetch.ml) and a
[command-line tool](./ofetch_cli.ml) (the `ofetch` binary).

The library supports concurrent fetching of multiple files using asynchronous sockets.

The I/O effects are abstracted away (see the `Peer_S` signature in `ofetch.mli`), so it can be made to work with any event loop-like layer that happens to look a lot like the beautiful interface of Unix' `select(2)` with non-blocking sockets, which is what backs the `ofetch_unix.ml` implementation. No `kqueue` or `epoll` or [`io_uring`](https://lwn.net/Articles/776703/) to see here.

### Limitations

- [x] ~The return code does not reflect the status of the download operation.~ It will return `0 on success` and `1 on error`. HTTP response code still ignored.
- [ ] The HTTP response code is currently ignored.
- [ ] Retrying / resuming is not implemented.
- [ ] Parallelized fetching of the same file is not implemented in the CLI tool.
  - [ ] Pipelined (using `Connection: keep-alive`) fetching is not implemented.
- [ ] Concurrent fetching of multiple files is not implemented in the CLI tool.
- [ ] Writes to disk are blocking (not using the asynchronous event loop).
- [x] ~HTTPS is not implemented (to avoid depending on C-based TLS
      implementations).~
      ~A switch for building with [tls](https://github.com/mirleft/tls) support
      is on the drawing board.~ It will automatically compile with TLS support from the mirleft `tls` package if installed.

### Usage

```shell
./_build/ofetch
Usage: ./_build/ofetch [-v] <LOCAL-FILENAME> <URL>

./_build/ofetch -v my.new.file http://example.com/cool.file.tar.xz
```

### Building

Building the `ofetch` binary:
```shell
# same as 'make cli', build the ELF binary:
make
```

Running the test suite:
```shell
# note that 'make test' requires 'ocamlfind', and the
# ocaml libraries 'alcotest' and 'qcheck':

make test

# build the ofetch binary and try downloading various files from the internet,
# running wget in parallel and comparing the downloaded files:

make network-test
```

For debugging there is also
```shell
# build a bytecode executable for use with 'ocamldebug':

make debug
```

### Contributing

- Samples that trigger parsing/state machine errors are greatly appreciated.
- Extending the test suite with more coverage would also be great!
- CI would be amazing, too!