Gemini Webbrowser

Build & Setup

Prerequisites :

• Haskell is installed.
• Cabal version = 3.10.2.1 is installed.
• GHC version = 9.4.8 is installed.

Clone repo with preferred method

1. (SSH): git clone git@github.com:Halvor0808/gemini-webbrowser.git
2. (HTTPS): git https://github.com/Halvor0808/gemini-webbrowser.git

Change directory to the root of the project: cd gemini-webbrowser

Build & Setup: Graders INF221

If you are grading my INF221 submission: git fetch --all.

git tag 221-submission

Checkout this git tag: git checkout 221-submission

There is a cabal.freeze file in the repository that will automatically choose the right dependencies. Navigate to root of project and then run: cabal update & cabal run.

Tests

There is the tiniest Test Suite called test. Run it by running cabal test from the root directory.

There are also some unit tests. Run them by running cabal repl test, and then running unitTests

Known issues

• TLS implementation does not work on windows for some servers
• Apprarently Emojis and other "wide" charcaters are not well supported in Brick. Since they affect the spacing pushing everything along. To fix this it requires a workaround in VTY. Since this is not crucial to my application, I deem it to be outside the scope of this project, and I cannot be bothered.
• Improve & update Help/control page

TODO

• [x] Change to LazyByteStrings

• Protocol

  • Parsers
  • Response
    • [ ] What to do with makeMime, pMime & Mime
    • Currently: recovers for any mistake with default: text/gemini charset=utf-8. Should it fail instead of default? Should it only default if whole <META> is empty ("")?
      • From Gemini's Docs: If a MIME type begins with "text/" and no charset is explicitly given, the charset should be assumed to be UTF-8. Compliant clients MUST support UTF-8-encoded text/* responses. Clients MAY optionally support other encodings. Clients receiving a response in a charset they cannot decode SHOULD gracefully inform the user what happened instead of displaying garbage. If is an empty string, the MIME type MUST default to "text/gemini; charset=utf-8". The text/gemini media type is defined in section 5.
    • [ ] Deal with charset

• TUI - Brick

  • [x] Basic Controls: quit, send request, exit, scrolling
  • [x] Handle navigating with links
  • [x] Cursor and navigating with keyboard
  • [x] Resolving relative URLs
  • [x] Allow history, and history navigation
  • [ ] Handle preformatted lines being cut off.
  • [ ] When rendering pages, the border is choppy

TUI Goal:

|-----------Gemini-Browser----------|
|             Searchbar             |
|-----------------------------------|
|                                   |
|                                   |
|                                   |
|          Page contents            |
|                                   |
|                                   |
|                                   |
|-----------------------------------|
|            basic help             |
|-----------------------------------|