opossum

README

Opossum Web Browser

Basic portable Web browser; only needs a Go compiler to compile. Optimized for use on 9front and 9legacy, supports plan9port and 9pi as well.

The UI is built with https://github.com/mjl-/duit

Still experimental and a lot of features are missing.

Supported features:

• rudimentary HTML5 and CSS support, large parts like float/flex layout are just stub implementations
• Server-side rendered websites
• Images (pre-loaded all at once though)
• TLS
• experimental JS/DOM can be activated (very basic jQuery examples work)
• file downloads

Install

Plan 9

# Setup TLS
hget https://curl.haxx.se/ca/cacert.pem > /sys/lib/tls/ca.pem
# Create mountpoints (needed on 9legacy)
mkdir /mnt/opossum
mkdir /mnt/sparkle

Binary

Binaries for amd64 and 386 can be downloaded from https://psilva.sdf.org/opossum.html

Compile from Source

Set $GOPROXY to https://proxy.golang.org and then:

go install ./cmd/opossum

Command line options:

-h                   help
-v                   verbose
-vv                  print debug messages
-jsinsecure          activate js
-cpuprofile filename create cpuprofile

(-v and -vv produce a lot of output, consider turning on scroll since processing waits for that...)

$font is used to select the font. Very large fonts will set dpi to 200.

macOS

Requirements:

• Go
• Plan9Port

go install ./cmd/opossum

JS support

It's more like a demo and it's not really clear right now how much sandboxing is really needed. A rudimentary AJAX implementation is there though.

Use on your own Risk!

JS implementation forked from goja (and thus otto). Since the implementation is very limited anyway, DOM changes are only computed initially and during click events. A handful of jQuery UI widgets work though, e.g. jQuery UI Tab view https://jqueryui.com/resources/demos/tabs/default.html. There is also highly experimental ES6 support with Babel. (https://github.com/psilva261/6to5)

Install the js engine:

cd ..
git/clone https://github.com/psilva261/sparklefs
cd sparklefs
go install ./cmd/sparklefs

On 9legacy also the folders /mnt/opossum and /mnt/sparkle need to exist.

Then it can be tested with:

opossum -jsinsecure https://jqueryui.com/resources/demos/tabs/default.html

TODO

• load images on the fly
• implement more parts of HTML5 and CSS
• create a widget for div/span
• clean up code, support webfs, snarf

Documentation

Index

• Constants
• func Group(u *user.User) (string, error)
• type ContentType
  • func NewContentType(s string, u *url.URL) (c ContentType, err error)
  • func (c ContentType) Charset() (cs string)
  • func (c ContentType) Encoding() (e encoding.Encoding)
  • func (c ContentType) IsCSS() bool
  • func (c ContentType) IsDownload() bool
  • func (c ContentType) IsEmpty() bool
  • func (c ContentType) IsHTML() bool
  • func (c ContentType) IsJS() bool
  • func (c ContentType) IsPlain() bool
  • func (c ContentType) IsSvg() bool
  • func (c ContentType) Utf8(buf []byte) string
• type Fetcher

Constants

const PathPrefix = "opossum"

Functions

func Group

func Group(u *user.User) (string, error)

Types

type ContentType

type ContentType struct {
	MediaType string
	Params    map[string]string
}

func NewContentType

func NewContentType(s string, u *url.URL) (c ContentType, err error)

NewContentType based on mime type string and url including file extension as fallback

func (ContentType) Charset

func (c ContentType) Charset() (cs string)

func (ContentType) Encoding

func (c ContentType) Encoding() (e encoding.Encoding)

func (ContentType) IsCSS

func (c ContentType) IsCSS() bool

func (ContentType) IsDownload

func (c ContentType) IsDownload() bool

func (ContentType) IsEmpty

func (c ContentType) IsEmpty() bool

func (ContentType) IsHTML

func (c ContentType) IsHTML() bool

func (ContentType) IsJS

func (c ContentType) IsJS() bool

func (ContentType) IsPlain

func (c ContentType) IsPlain() bool

func (ContentType) IsSvg

func (c ContentType) IsSvg() bool

func (ContentType) Utf8

func (c ContentType) Utf8(buf []byte) string

type Fetcher

type Fetcher interface {
	Ctx() context.Context
	Origin() *url.URL

	// LinkedUrl relative to current page
	LinkedUrl(string) (*url.URL, error)

	Get(*url.URL) ([]byte, ContentType, error)
}