class web::WebUtil

sys::Obj
  web::WebUtil

@Js

Source

WebUtil encapsulates several useful utility web methods. Also see MimeType and its utility methods.

fromQuotedStr

const static Str fromQuotedStr(Str s)

Source

Decode a HTTP quoted string according to RFC 2616 Section 2.2. The given string must be wrapped in quotes. See toQuotedStr.

headersToCharset

const static Charset headersToCharset(Str:Str headers)

Source

Given a set of HTTP headers map Content-Type to its charset or default to UTF-8.

isToken

const static Bool isToken(Str s)

Source

Return if the specified string is a valid HTTP token production which is any ASCII character which is not a control char or a separator. The separators characters are:

"(" | ")" | "<" | ">" | "@" |
"," | ";" | ":" | "\" | <"> |
"/" | "[" | "]" | "?" | "=" |
"{" | "}" | SP | HT
isTokenChar

const static Bool isTokenChar(Int c)

Source

Return if given char unicode point is allowable within the HTTP token production. See isToken.

jsMain

const static Void jsMain(OutStream out, Str main, [Str:Str]? env := null)

Source

Generate the method invocation code used to boostrap into JavaScript from a webpage. This must be called inside the <head> tag for the page. The main method will be invoked using the onLoad DOM event.

The main argument can be either a type or method. If no method is specified, main is used. If the method is not static, a new instance of type is created:

"foo::Instance"     =>  Instance().main()
"foo::Instance.bar" =>  Instance().bar()
"foo::Static"       =>  Static.main()
"foo::Static.bar"   =>  Static.bar()

If env is specified, then vars will be added to and available from Env.vars on client-side.

makeChunkedInStream

const static InStream makeChunkedInStream(InStream in)

Source

Wrap the given input stream to read bytes using a HTTP chunked transfer encoding. The wrapped streams provides a contiguous stream of bytes until the last chunk is read. Closing the wrapper stream does not close the underlying stream.

makeChunkedOutStream

const static OutStream makeChunkedOutStream(OutStream out)

Source

Wrap the given output stream to write bytes using a HTTP chunked transfer encoding. Closing the wrapper stream terminates the chunking, but does not close the underlying stream.

makeContentInStream

const static InStream makeContentInStream(Str:Str headers, InStream in)

Source

Given a set of headers, wrap the specified input stream to read the content body:

  1. If Content-Encoding is gzip then wrap via Zip.gzipInStream
  2. If Content-Length then makeFixedInStream
  3. If Transfer-Encoding is chunked then makeChunkedInStream
  4. If Content-Type assume non-pipelined connection and return in directly

If a stream is returned, then it is automatically configured with the correct content encoding based on the Content-Type.

makeContentOutStream

const static OutStream? makeContentOutStream(Str:Str headers, OutStream out)

Source

Given a set of headers, wrap the specified output stream to write the content body:

  1. If Content-Length then makeFixedOutStream
  2. If Content-Type then set Transfer-Encoding header to chunked and return makeChunkedOutStream
  3. Assume no content and return null

If a stream is returned, then it is automatically configured with the correct content encoding based on the Content-Type.

makeFixedInStream

const static InStream makeFixedInStream(InStream in, Int fixed)

Source

Wrap the given input stream to read a fixed number of bytes. Once fixed bytes have been read from the underlying input stream, the wrapped stream will return end-of-stream. Closing the wrapper stream does not close the underlying stream.

makeFixedOutStream

const static OutStream makeFixedOutStream(OutStream out, Int fixed)

Source

Wrap the given output stream to write a fixed number of bytes. Once fixed bytes have been written, attempting to further bytes will throw IOErr. Closing the wrapper stream does not close the underlying stream.

parseHeaders

const static Str:Str parseHeaders(InStream in)

Source

Parse a series of HTTP headers according to RFC 2616 section 4.2. The final CRLF which terminates headers is consumed with the stream positioned immediately following. The headers are returned as a case insensitive map. Throw ParseErr if headers are malformed.

parseList

const static Str[] parseList(Str s)

Source

Parse a list of comma separated tokens. Any leading or trailing whitespace is trimmed from the list of tokens.

parseMultiPart

const static Void parseMultiPart(InStream in, Str boundary, |Str:Str,InStream| cb)

Source

Parse a multipart/form-data input stream. For each part in the stream call the given callback function with the part's headers and an input stream used to read the part's body. Each callback must completely drain the input stream to prepare for the next part. Also see WebReq.parseMultiPartForm.

parseQVals

const static Str:Float parseQVals(Str s)

Source

Given an HTTP header that uses q values, return a map of name/q-value pairs. This map has a def value of 0.

Example:

compress,gzip              =>  ["compress":1f, "gzip":1f]
compress;q=0.5,gzip;q=0.0  =>  ["compress":0.5f, "gzip":0.0f]
toQuotedStr

const static Str toQuotedStr(Str s)

Source

Return the specified string as a HTTP quoted string according to RFC 2616 Section 2.2. The result is wrapped in quotes. Throw ArgErr if any character is outside of the ASCII range of 0x20 to 0x7e. The quote char itself is backslash escaped. See fromQuotedStr.