A simple Gopher client for KaiOS
git clone git://git.luxferre.top/kopher.git
Log | Files | Refs | README | LICENSE

README.md (9100B)

      1 # Kopher: a simple Gopher client/browser for KaiOS
      3 > Yo dawg, we put a browser in your browser, so you can browse Gopher while you browse KaiOS UI
      5 ## What is it?
      7 Kopher is a really small (under 500 SLOC of HTML+JS) client to browse pages ("holes") using Gopher protocol. Besides Gophermaps, it also allows to display plain text downloaded via this protocol "as is" and redirect to the system browser to view non-Gopher protocol links and download non-text media file types.
      9 Structurally, Kopher is a KaiOS-specific frontend to the hi01379.js library which is developed under the same project. Both the library and the app are designed to be as lightweight as practically possible.
     11 Installation is as usual, via WebIDE. For GerdaOS, you can prepare the `kopher.gpkg.zip` file as follows:
     13 ```
     14 zip -9r --exclude=*.git* --exclude=*.DS_Store* --exclude=README.md ../application.zip .
     15 cd ..
     16 echo {\"version\": 1, \"manifestURL\": \"app://kopher.luxferre.top/manifest.webapp\"} > metadata.json
     17 zip -9 kopher.gpkg.zip application.zip metadata.json
     18 ```
     20 ## Which KaiOS versions are supported?
     22 Tested on 2.5.x up to 2.5.4. Doesn't work on 1.0 (some bug with mozTCPSockets I'm not gonna investigate) and definitely won't work on 3.x.
     24 More specifically, as of now, Kopher has been tested on the following devices and KaiOS versions (ordered from oldest to newest):
     26 - Nokia 8110 4G v13 (2.5/GerdaOS)
     27 - Nokia 8110 4G v17 (2.5.1)
     28 - Doro 7060 (DFC-0190) (2.5.1)\*
     29 - Sigma mobile S3500 sKai (\*\*
     30 - Nokia 800 Tough (2.5.2)
     31 - Nokia 2720 Flip (
     32 - Crosscall Core-S4 (
     33 - Nokia 8000 4G (2.5.4)
     35 *\* install-via-FFBM trick; also, the system statusbar on the Doro is larger than usual, so the addressbar is a bit overlapped (doesn't hamper its readability)*
     37 *\*\* there is a bug with displaying Blob-type images on the sKai, so only the download option works correctly*
     39 N.B. If you want to debug Kopher to support KaiOS 1.0, make sure to replace the `'\u{1f310}'` reference in `js/app.js` with `'\uD83C\uDF10'` surrogate pair first.
     41 ## Which Gophermap entry types are supported?
     43 They are listed in the hi01379.js library name:
     45 - `0` (plain text)
     46 - `1` (Gophermap)
     47 - `3` (error message)
     48 - `7` (search request)
     49 - `9` (arbitrary binary type), as well as `g` (GIF image file)
     50 - `i` (information message), as well as `I` (generic image file)
     51 - `h` (external URL)
     53 Outside this list, unknown binary types (`5`, `s`, `;`, `d`) are just treated as type `9` internally, and every other type is assumed to be plain text on access. The 8-type entries are just converted to `telnet://` URIs with no logic attached.
     55 In the Gophermap, any line that doesn't contain tabulation characters is automatically considered an information line by Kopher client and hi01379.js library. This allows to display messages from Gopher servers that don't strictly adhere to the format, such as Gophernicus or PyGopherd.
     57 Note that currently, Kopher and hi01379.js assume that the search request from a 7-type entry will lead to another Gophermap and not to any other resource type. This was necessary to remove ambiguity, as the client doesn't heuristically determine the response type from its body.
     59 ## Which UI features are supported?
     61 - Minimalistic but easy and quick WAP-like navigation (see "Controls")
     62 - The `gopher://` scheme is assumed by default (no need to enter it manually), same for the port 70
     63 - One-key light/dark theme toggle
     64 - One-key switching the line wrapping mode between off (default) and on (for comfortable reading even the hard-wrapped documents)
     65 - Unlimited navigation history (doesn't persist between sessions)
     66 - Up to 10 numbered bookmarks plus customizable homepage
     67 - Binary blob downloads (see "Downloads")
     68 - Limited support of ANSI terminal escape codes in Gophermap infolines (see "Does it have terminal emulation support for character styling?")
     70 ## Controls
     72 Kopher's controls were inspired by old WAP browsers and partially Opera Mini. Once you get used to them, navigation becomes blazingly fast.
     74 - Scrolling: `Up`/`Down`/`Left`/`Right`
     75 - Previous/next link: `2`/`5`
     76 - Click on the link: `Center`
     77 - Enter address: Left Soft Key
     78 - Go back: `1` or Right Soft Key
     79 - Go forward: `3`
     80 - Refresh: `Call`
     81 - Page start/end: `8`/`0`
     82 - Line start/end: `7`/`9`
     83 - Open the homepage: `# *`
     84 - Open a bookmark: `# [num]`
     85 - Save to the homepage: `* *`
     86 - Save to a bookmark: `* [num]`
     87 - Share the URL: `* Call`
     88 - Toggle light/dark theme: `4`
     89 - Toggle line wrapping: `6`
     90 - Version and page info: `# #`
     91 - Exit: End
     93 ## Downloads
     95 For image files supported by KaiOS, Kopher prompts whether or not you want to just view or store them, and if you choose to store them, they are saved to your default gallery storage. All other types are downloaded directly **to the root of your default storage** (the storage you selected in KaiOS setttings as the default media location, be it internal or the SD card). Note that Kopher does not do any heuristics on how the downloads folder should be named, nor does it create any by itself. Different phones handle the download storage place differently and B2G doesn't have a specific designator for it, so just using the root is the safest and most cross-device way of saving the files.
     97 Note that in most KaiOS phones the internal storage root isn't fully viewable with the stock file manager, so you might have to use MTP and/or third-party file managers like Explorer to see the files if this is the case with your device. For more consistent UX with downloads, please consider using an SD card as the default storage.
     99 ## Wait... no input fields in the UI?!
    101 Exactly. No need to reinvent the wheel when the JS engine offers the `prompt()` method. You enter the starting address in the popup window, same way you enter search queries in the gopherholes.
    103 For your convenience, only the current hole hostname is always displayed in the header bar, and the status bar with service messages or the current resource path is always displayed below. You can view the full URL/URI in the "Version and page info" popup accessed with `# #` combo.
    105 ## Does it have Unicode support?
    107 Yes. In fact, UTF-8 is the only supported encoding. As ASCII is a subset of UTF-8, old ASCII-only resources will be displayed just fine as well.
    109 ## Does it have terminal emulation support for character styling?
    111 As of April 2023, Kopher implements a subset of ANSI terminal escape codes for text styling purposes with the following limitations:
    113 - they are applied to the Gophermap information lines **only** (and detected and deleted everywhere else);
    114 - they only work within the single infoline or a block of sequential infolines and all styling gets reset when another entry type is encountered, even if the reset sequence isn't there;
    115 - only the basic 16-color palette is implemented (because these codes physically translate into corresponding data attributes);
    116 - beside the colors, the following text attributes are implemented: bold, italic, underline, blinking, inverse, hidden, strikethrough;
    117 - any unsupported escape sequences are automatically deleted from the rendered output.
    119 All these limitations are intended to keep Kopher's codebase simple, and not likely to change in the foreseeable future.
    121 ## How does Kopher integrate with the rest of KaiOS?
    123 It almost doesn't. But, whatever could be done without hacks, has been done since the version 0.0.6. First, you can share the current URL (in the `gopher://` format) using Bluetooth/Messages/Email share menu (if you select Bluetooth or any other provider that requires blobs, it gets sent as a vCard 2.1 file with the `N` and `URL` fields set to the same value) by pressing `*` and Call key. Second, Kopher itself registers a `view` activity handler for every URL that starts with `gopher:`. If you just updated Kopher to version 0.0.6, you need to reboot your phone for this feature to start working. In the current state of KaiOS, `gopher:` URLs aren't picked up and translated into proper activities by the stock KaiOS browser or the `window.open()` call, but any other application that sends URLs to the `view` activity according to the spec should be able to open `gopher://` URLs in Kopher.
    125 ## Can I use the hi01379.js library in non-KaiOS environments?
    127 Yes, but you'll need to supply your own `gopherRequest(resource, input, successCb, errorCb)` function/method that performs the actual resource download over TCP. The `success` callback must always return a raw binary data string. See the js/transport.js file for the reference of how it's done for KaiOS (using mozTCPSocket API).
    129 If you only need the Gophermap rendering functionality, you can provide a dummy function and only use the `Hi01379.render()` method. Note that the library generates links in its own internal and more efficient `hi:[type]|[selector]|[host]|[port]` URI format, where the fields are specified in the same order they appear in the Gophermap. It's up to the callers to convert these links to the standard `gopher://[host]:[port]/[type][selector]` URL scheme if they need to.
    131 ## What's the license on this?
    133 Fully public domain.