mirror of
https://github.com/urbit/shrub.git
synced 2024-12-01 14:42:02 +03:00
8570a8f3c9
A repeating patern while developing was confusion over whether an operation was inbound or outbound. By putting this into the gift and tasks, we can avoid this: an [%http-server %request ...] is not an [%http-client %request ...]. (This requires corresponding vere changes since it changes the unix/vane interface.)
2005 lines
60 KiB
Plaintext
2005 lines
60 KiB
Plaintext
!:
|
|
:: lighter than eyre
|
|
::
|
|
|= pit=vase
|
|
=, light
|
|
:: internal data structures
|
|
::
|
|
=> =~
|
|
::
|
|
:: internal data structures that won't go in zuse
|
|
::
|
|
|%
|
|
+$ move
|
|
::
|
|
$: :: duct: request identifier
|
|
::
|
|
=duct
|
|
::
|
|
::
|
|
card=(wind note gift:able)
|
|
==
|
|
:: +note: private request from light to another vane
|
|
::
|
|
+$ note
|
|
$% :: %b: to behn
|
|
::
|
|
$: %b
|
|
::
|
|
::
|
|
$% [%rest p=@da]
|
|
[%wait p=@da]
|
|
== ==
|
|
:: %f: to ford
|
|
::
|
|
$: %f
|
|
::
|
|
::
|
|
$% [%build live=? schematic=schematic:ford]
|
|
[%kill ~]
|
|
== ==
|
|
:: %g: to gall
|
|
::
|
|
$: %g
|
|
::
|
|
::
|
|
$% [%deal id=sock data=cush:gall]
|
|
== == ==
|
|
:: +sign: private response from another vane to ford
|
|
::
|
|
+$ sign
|
|
$% :: %b: from behn
|
|
::
|
|
$: %b
|
|
::
|
|
::
|
|
$% [%wake ~]
|
|
== ==
|
|
:: %f: from ford
|
|
::
|
|
$: %f
|
|
::
|
|
::
|
|
$% [%made date=@da result=made-result:ford]
|
|
== ==
|
|
:: %g: from gall
|
|
::
|
|
$: %g
|
|
::
|
|
::
|
|
$% [%unto p=cuft:gall]
|
|
== == ==
|
|
--
|
|
:: more structures
|
|
::
|
|
|%
|
|
++ axle
|
|
$: :: date: date at which light's state was updated to this data structure
|
|
::
|
|
date=%~2019.1.7
|
|
:: client-state: state of outbound requests
|
|
::
|
|
client-state=state:client
|
|
:: server-state: state of inbound requests
|
|
::
|
|
=server-state
|
|
==
|
|
:: +client: light as an http client
|
|
::
|
|
++ client
|
|
|%
|
|
:: +state:client: state relating to open outbound HTTP connections
|
|
::
|
|
+$ state
|
|
$: :: next-id: monotonically increasing id number for the next connection
|
|
::
|
|
next-id=@ud
|
|
:: connection-by-id: open connections to the
|
|
::
|
|
connection-by-id=(map @ud [=duct =in-progress-http-request])
|
|
:: outbound-duct: the duct to send outbound requests on
|
|
::
|
|
outbound-duct=duct
|
|
==
|
|
:: +in-progress-http-request: state around an outbound http
|
|
::
|
|
+$ in-progress-http-request
|
|
$: :: remaining-redirects: http limit of number of redirects before error
|
|
::
|
|
remaining-redirects=@ud
|
|
:: remaining-retries: number of times to retry the request
|
|
::
|
|
remaining-retries=@ud
|
|
:: response-headers: the response headers from the %start packet
|
|
::
|
|
:: We send the response headers with each %http-progress, so we must
|
|
:: save them.
|
|
::
|
|
response-headers=(unit http-response-header)
|
|
:: chunks: a list of partial results returned from unix
|
|
::
|
|
:: This list of octs must be flopped before it is composed as the
|
|
:: final response, as we want to be able to quickly insert.
|
|
::
|
|
chunks=(list octs)
|
|
:: bytes-read: the sum of the size of the :chunks
|
|
::
|
|
bytes-read=@ud
|
|
:: expected-size: the expected content-length of the http request
|
|
::
|
|
expected-size=(unit @ud)
|
|
==
|
|
--
|
|
:: +server-state: state relating to open inbound HTTP connections
|
|
::
|
|
+$ server-state
|
|
$: :: bindings: actions to dispatch to when a binding matches
|
|
::
|
|
:: Eyre is responsible for keeping its bindings sorted so that it
|
|
:: will trigger on the most specific binding first. Eyre should send
|
|
:: back an error response if an already bound binding exists.
|
|
::
|
|
:: TODO: It would be nice if we had a path trie. We could decompose
|
|
:: the :binding into a (map (unit @t) (trie knot =action)).
|
|
::
|
|
bindings=(list [=binding =duct =action])
|
|
:: connections: open http connections not fully complete
|
|
::
|
|
connections=(map duct outstanding-connection)
|
|
:: authentication-state: state managed by the +authentication core
|
|
::
|
|
=authentication-state
|
|
:: channel-state: state managed by the +channel core
|
|
::
|
|
=channel-state
|
|
==
|
|
:: +outstanding-connection: open http connections not fully complete:
|
|
::
|
|
:: This refers to outstanding connections where the connection to
|
|
:: outside is opened and we are currently waiting on ford or an app to
|
|
:: produce the results.
|
|
::
|
|
+$ outstanding-connection
|
|
$: :: action: the action that had matched
|
|
::
|
|
=action
|
|
:: inbound-request: the original request which caused this connection
|
|
::
|
|
=inbound-request
|
|
:: code: the status code, if sent
|
|
::
|
|
code=(unit @ud)
|
|
:: headers: the headers, if sent
|
|
::
|
|
headers=(unit header-list)
|
|
:: bytes-sent: the total bytes sent in response
|
|
::
|
|
bytes-sent=@ud
|
|
==
|
|
:: +action: the action to take when a binding matches an incoming request
|
|
::
|
|
+$ action
|
|
$% :: dispatch to a generator
|
|
::
|
|
[%gen =generator]
|
|
:: dispatch to an application
|
|
::
|
|
[%app app=term]
|
|
:: internal authentication page
|
|
::
|
|
[%authentication ~]
|
|
:: gall channel system
|
|
::
|
|
[%channel ~]
|
|
:: respond with the default file not found page
|
|
::
|
|
[%four-oh-four ~]
|
|
==
|
|
:: +authentication-state: state used in the login system
|
|
::
|
|
+$ authentication-state
|
|
$: :: sessions: a mapping of session cookies to session information
|
|
::
|
|
sessions=(map @uv session)
|
|
==
|
|
:: +session: server side data about a session
|
|
::
|
|
+$ session
|
|
$: :: expiry-time: when this session expires
|
|
::
|
|
:: We check this server side, too, so we aren't relying on the browser
|
|
:: to properly handle cookie expiration as a security mechanism.
|
|
::
|
|
expiry-time=@da
|
|
::
|
|
:: TODO: We should add a system for individual capabilities; we should
|
|
:: mint some sort of long lived cookie for mobile apps which only has
|
|
:: access to a single application path.
|
|
==
|
|
:: channel-state: state used in the channel system
|
|
::
|
|
+$ channel-state
|
|
$: :: session: mapping between an arbitrary key to a channel
|
|
::
|
|
session=(map @t channel)
|
|
:: by-duct: mapping from ducts to session key
|
|
::
|
|
duct-to-key=(map duct @t)
|
|
==
|
|
:: +timer: a reference to a timer so we can cancel or update it.
|
|
::
|
|
+$ timer
|
|
$: :: date: time when the timer will fire
|
|
::
|
|
date=@da
|
|
:: duct: duct that set the timer so we can cancel
|
|
::
|
|
=duct
|
|
==
|
|
:: channel: connection to the browser
|
|
::
|
|
:: Channels are the main method where a webpage communicates with Gall
|
|
:: apps. Subscriptions and pokes are issues with PUT requests on a path,
|
|
:: while GET requests on that same path open a persistent EventSource
|
|
:: channel.
|
|
::
|
|
:: The EventSource API is a sequence number based API that browser provide
|
|
:: which allow the server to push individual events to the browser over a
|
|
:: connection held open. In case of reconnection, the browser will send a
|
|
:: 'Last-Event-Id: ' header to the server; the server then resends all
|
|
:: events since then.
|
|
::
|
|
:: TODO: Send \n as a heartbeat every 20 seconds.
|
|
::
|
|
+$ channel
|
|
$: :: channel-state: expiration time or the duct currently listening
|
|
::
|
|
:: For each channel, there is at most one open EventSource
|
|
:: connection. A 400 is issues on duplicate attempts to connect to the
|
|
:: same channel. When an EventSource isn't connected, we set a timer
|
|
:: to reap the subscriptions. This timer shouldn't be too short
|
|
:: because the
|
|
::
|
|
state=(each timer duct)
|
|
:: next-id: next sequence number to use
|
|
::
|
|
next-id=@ud
|
|
:: events: unacknowledged events
|
|
::
|
|
:: We keep track of all events where we haven't received a
|
|
:: 'Last-Event-Id: ' response from the client or a per-poke {'ack':
|
|
:: ...} call. When there's an active EventSource connection on this
|
|
:: channel, we send the event but we still add it to events because we
|
|
:: can't assume it got received until we get an acknowledgment.
|
|
::
|
|
events=(qeu [id=@ud lines=wall])
|
|
:: subscriptions: gall subscriptions
|
|
::
|
|
:: We maintain a list of subscriptions so if a channel times out, we
|
|
:: can cancel all the subscriptions we've made.
|
|
::
|
|
subscriptions=(list [ship=@p app=term =path])
|
|
==
|
|
:: channel-request: an action requested on a channel
|
|
::
|
|
+$ channel-request
|
|
$% :: %ack: acknowledges that the client has received events up to :id
|
|
::
|
|
[%ack event-id=@ud]
|
|
:: %poke: pokes an application, translating :json to :mark.
|
|
::
|
|
[%poke request-id=@ud ship=@p app=term mark=@tas =json]
|
|
:: %subscribe: subscribes to an application path
|
|
::
|
|
[%subscribe request-id=@ud ship=@p app=term =path]
|
|
:: %unsubscribe: unsubscribes from an application path
|
|
::
|
|
[%unsubscribe request-id=@ud ship=@p app=term =path]
|
|
==
|
|
:: channel-timeout: the delay before a channel should be reaped
|
|
::
|
|
++ channel-timeout ~h12
|
|
--
|
|
:: utilities
|
|
::
|
|
|%
|
|
:: +combine-octs: combine multiple octs into one
|
|
::
|
|
++ combine-octs
|
|
|= a=(list octs)
|
|
^- octs
|
|
:- %+ roll a
|
|
|= [=octs sum=@ud]
|
|
(add sum p.octs)
|
|
(can 3 a)
|
|
:: +prune-events: removes all items from the front of the queue up to :id
|
|
::
|
|
++ prune-events
|
|
|= [q=(qeu [id=@ud lines=wall]) id=@ud]
|
|
^+ q
|
|
:: if the queue is now empty, that's fine
|
|
::
|
|
?: =(~ q)
|
|
~
|
|
::
|
|
=/ next=[item=[id=@ud lines=wall] _q] ~(get to q)
|
|
:: if the head of the queue is newer than the acknowledged id, we're done
|
|
::
|
|
?: (gth id.item.next id)
|
|
q
|
|
:: otherwise, check next item
|
|
::
|
|
$(q +:next)
|
|
:: +parse-channel-request: parses a list of channel-requests
|
|
::
|
|
:: Parses a json array into a list of +channel-request. If any of the items
|
|
:: in the list fail to parse, the entire thing fails so we can 400 properly
|
|
:: to the client.
|
|
::
|
|
++ parse-channel-request
|
|
|= request-list=json
|
|
^- (unit (list channel-request))
|
|
:: parse top
|
|
::
|
|
=, dejs-soft:format
|
|
=- ((ar -) request-list)
|
|
::
|
|
|= item=json
|
|
^- (unit channel-request)
|
|
::
|
|
?~ maybe-key=((ot action+so ~) item)
|
|
~
|
|
?: =('ack' u.maybe-key)
|
|
((pe %ack (ot event-id+ni ~)) item)
|
|
?: =('poke' u.maybe-key)
|
|
((pe %poke (ot id+ni ship+(su fed:ag) app+so mark+(su sym) json+some ~)) item)
|
|
?: =('subscribe' u.maybe-key)
|
|
%. item
|
|
%+ pe %subscribe
|
|
(ot id+ni ship+(su fed:ag) app+so path+(su ;~(pfix fas (more fas urs:ab))) ~)
|
|
?: =('unsubscribe' u.maybe-key)
|
|
%. item
|
|
%+ pe %unsubscribe
|
|
(ot id+ni ship+(su fed:ag) app+so path+(su ;~(pfix fas (more fas urs:ab))) ~)
|
|
:: if we reached this, we have an invalid action key. fail parsing.
|
|
::
|
|
~
|
|
:: +file-not-found-page: 404 page for when all other options failed
|
|
::
|
|
++ file-not-found-page
|
|
|= url=@t
|
|
^- octs
|
|
%- as-octs:mimes:html
|
|
%- crip
|
|
%- en-xml:html
|
|
;html
|
|
;head
|
|
;title:"404 Not Found"
|
|
==
|
|
;body
|
|
;h1:"Not Found"
|
|
;p:"The requested URL {<(trip url)>} was not found on this server."
|
|
==
|
|
==
|
|
:: +login-page: internal page to login to an Urbit
|
|
::
|
|
++ login-page
|
|
|= redirect-url=(unit @t)
|
|
^- octs
|
|
=+ redirect-str=?~(redirect-url "" (trip u.redirect-url))
|
|
%- as-octs:mimes:html
|
|
%- crip
|
|
%- en-xml:html
|
|
;html
|
|
;head
|
|
;title:"Sign in"
|
|
==
|
|
;body
|
|
;h1:"Sign in"
|
|
;form(action "/~/login", method "post", enctype "application/x-www-form-urlencoded")
|
|
;input(type "password", name "password", placeholder "passcode");
|
|
;input(type "hidden", name "redirect", value redirect-str);
|
|
;button(type "submit"):"Login"
|
|
==
|
|
==
|
|
==
|
|
:: +render-tang-to-marl: renders a tang and adds <br/> tags between each line
|
|
::
|
|
++ render-tang-to-marl
|
|
|= {wid/@u tan/tang}
|
|
^- marl
|
|
=/ raw=(list tape) (zing (turn tan |=(a/tank (wash 0^wid a))))
|
|
::
|
|
|- ^- marl
|
|
?~ raw ~
|
|
[;/(i.raw) ;br; $(raw t.raw)]
|
|
:: +render-tang-to-wall: renders tang as text lines
|
|
::
|
|
++ render-tang-to-wall
|
|
|= {wid/@u tan/tang}
|
|
^- wall
|
|
(zing (turn tan |=(a=tank (wash 0^wid a))))
|
|
:: +wall-to-octs: text to binary output
|
|
::
|
|
++ wall-to-octs
|
|
|= =wall
|
|
^- (unit octs)
|
|
::
|
|
?: =(~ wall)
|
|
~
|
|
::
|
|
:- ~
|
|
%- as-octs:mimes:html
|
|
%- crip
|
|
%- zing
|
|
%+ turn wall
|
|
|= t=tape
|
|
"{t}\0a"
|
|
:: +internal-server-error: 500 page, with a tang
|
|
::
|
|
++ internal-server-error
|
|
|= [authorized=? url=@t t=tang]
|
|
^- octs
|
|
%- as-octs:mimes:html
|
|
%- crip
|
|
%- en-xml:html
|
|
;html
|
|
;head
|
|
;title:"500 Internal Server Error"
|
|
==
|
|
;body
|
|
;h1:"Internal Server Error"
|
|
;p:"There was an error while handling the request for {<(trip url)>}."
|
|
;* ?: authorized
|
|
;=
|
|
;code:"*{(render-tang-to-marl 80 t)}"
|
|
==
|
|
~
|
|
==
|
|
==
|
|
:: +channel-js: the urbit javascript interface
|
|
::
|
|
:: TODO: Must send 'acks' to the server.
|
|
::
|
|
++ channel-js
|
|
^- octs
|
|
%- as-octs:mimes:html
|
|
'''
|
|
class Channel {
|
|
constructor() {
|
|
// unique identifier: current time and random number
|
|
//
|
|
this.uid =
|
|
new Date().getTime().toString() +
|
|
"-" +
|
|
Math.random().toString(16).slice(-6);
|
|
|
|
this.requestId = 1;
|
|
|
|
// the currently connected EventSource
|
|
//
|
|
this.eventSource = null;
|
|
|
|
// the id of the last EventSource event we received
|
|
//
|
|
this.lastEventId = 0;
|
|
|
|
// this last event id acknowledgment sent to the server
|
|
//
|
|
this.lastAcknowledgedEventId = 0;
|
|
|
|
// a registry of requestId to successFunc/failureFunc
|
|
//
|
|
// These functions are registered during a +poke and are executed
|
|
// in the onServerEvent()/onServerError() callbacks. Only one of
|
|
// the functions will be called, and the outstanding poke will be
|
|
// removed after calling the success or failure function.
|
|
//
|
|
this.outstandingPokes = new Map();
|
|
|
|
// a registry of requestId to subscription functions.
|
|
//
|
|
// These functions are registered during a +subscribe and are
|
|
// executed in the onServerEvent()/onServerError() callbacks. The
|
|
// event function will be called whenever a new piece of data on this
|
|
// subscription is available, which may be 0, 1, or many times. The
|
|
// disconnect function may be called exactly once.
|
|
//
|
|
this.outstandingSubscriptions = new Map();
|
|
}
|
|
|
|
// sends a poke to an app on an urbit ship
|
|
//
|
|
poke(ship, app, mark, json, successFunc, failureFunc) {
|
|
var id = this.nextId();
|
|
this.outstandingPokes.set(
|
|
id, {"success": successFunc, "fail": failureFunc});
|
|
|
|
this.sendJSONToChannel({
|
|
"id": id,
|
|
"action": "poke",
|
|
"ship": ship,
|
|
"app": app,
|
|
"mark": mark,
|
|
"json": json
|
|
});
|
|
}
|
|
|
|
// subscribes to a path on an
|
|
//
|
|
subscribe(ship, app, path, connectionErrFunc, eventFunc, quitFunc) {
|
|
var id = this.nextId();
|
|
this.outstandingSubscriptions.set(
|
|
id, {"err": connectionErrFunc, "event": eventFunc, "quit": quitFunc});
|
|
|
|
this.sendJSONToChannel({
|
|
"id": id,
|
|
"action": "subscribe",
|
|
"ship": ship,
|
|
"app": app,
|
|
"path": path
|
|
});
|
|
}
|
|
|
|
// sends a JSON command command to the server.
|
|
//
|
|
sendJSONToChannel(j) {
|
|
var req = new XMLHttpRequest();
|
|
req.open("PUT", this.channelURL());
|
|
req.setRequestHeader("Content-Type", "application/json");
|
|
|
|
if (this.lastEventId == this.lastAcknowledgedEventId) {
|
|
var x = JSON.stringify([j]);
|
|
req.send(x);
|
|
} else {
|
|
// we add an acknowledgment to clear the server side queue
|
|
//
|
|
// The server side puts messages it sends us in a queue until we
|
|
// acknowledge that we received it.
|
|
//
|
|
var x = JSON.stringify(
|
|
[{"action": "ack", "event-id": parseInt(this.lastEventId)}, j])
|
|
console.log(x, this.lastEventId);
|
|
req.send(x);
|
|
|
|
this.lastEventId = this.lastAcknowledgedEventId;
|
|
}
|
|
|
|
this.connectIfDisconnected();
|
|
}
|
|
|
|
// connects to the EventSource if we are not currently connected
|
|
//
|
|
connectIfDisconnected() {
|
|
if (this.eventSource) {
|
|
return;
|
|
}
|
|
|
|
this.eventSource = new EventSource(this.channelURL(), {withCredentials:true});
|
|
this.eventSource.onmessage = e => {
|
|
this.lastEventId = e.lastEventId;
|
|
|
|
var obj = JSON.parse(e.data);
|
|
if (obj.response == "poke") {
|
|
var funcs = this.outstandingPokes.get(obj.id);
|
|
if (obj.hasOwnProperty("ok"))
|
|
funcs["success"]()
|
|
else if (obj.hasOwnProperty("err"))
|
|
funcs["fail"](obj.err)
|
|
else
|
|
console.log("Invalid poke response: ", obj);
|
|
this.outstandingPokes.delete(obj.id);
|
|
|
|
} else if (obj.response == "subscribe") {
|
|
// on a response to a subscribe, we only notify the caller on err
|
|
//
|
|
var funcs = this.outstandingSubscriptions.get(obj.id);
|
|
if (obj.hasOwnProperty("err")) {
|
|
funcs["err"](obj.err);
|
|
this.outstandingSubscriptions.delete(obj.id);
|
|
} else {
|
|
console.log("Subscription establisthed");
|
|
}
|
|
} else if (obj.response == "diff") {
|
|
console.log("Diff: ", obj);
|
|
|
|
var funcs = this.outstandingSubscriptions.get(obj.id);
|
|
funcs["event"](obj.json);
|
|
|
|
} else if (obj.response == "quit") {
|
|
var funcs = this.outstandingSubscriptions.get(obj.id);
|
|
funcs["quit"](obj.err);
|
|
this.outstandingSubscriptions.delete(obj.id);
|
|
|
|
} else {
|
|
console.log("Unrecognized response: ", e);
|
|
}
|
|
}
|
|
|
|
this.eventSource.onerror = e => {
|
|
// TODO: The server broke the connection. Call every poke cancel and every
|
|
// subscription disconnect.
|
|
console.log(e);
|
|
}
|
|
}
|
|
|
|
channelURL() {
|
|
return "/~/channel/" + this.uid;
|
|
}
|
|
|
|
nextId() {
|
|
return this.requestId++;
|
|
}
|
|
};
|
|
|
|
export function newChannel() {
|
|
return new Channel;
|
|
}
|
|
'''
|
|
:: +format-ud-as-integer: prints a number for consumption outside urbit
|
|
::
|
|
++ format-ud-as-integer
|
|
|= a=@ud
|
|
^- tape
|
|
?: =(0 a) ['0' ~]
|
|
%- flop
|
|
|- ^- tape
|
|
?:(=(0 a) ~ [(add '0' (mod a 10)) $(a (div a 10))])
|
|
:: +path-matches: returns %.y if :prefix is a prefix of :full
|
|
::
|
|
++ path-matches
|
|
|= [prefix=path full=path]
|
|
^- ?
|
|
?~ prefix
|
|
%.y
|
|
?~ full
|
|
%.n
|
|
?. =(i.prefix i.full)
|
|
%.n
|
|
$(prefix t.prefix, full t.full)
|
|
:: +get-header: returns the value for :header, if it exists in :header-list
|
|
::
|
|
++ get-header
|
|
|= [header=@t =header-list]
|
|
^- (unit @t)
|
|
::
|
|
?~ header-list
|
|
~
|
|
::
|
|
?: =(key.i.header-list header)
|
|
`value.i.header-list
|
|
::
|
|
$(header-list t.header-list)
|
|
:: +simplified-url-parser: returns [(each @if @t) (unit port=@ud)]
|
|
::
|
|
++ simplified-url-parser
|
|
;~ plug
|
|
;~ pose
|
|
%+ stag %ip
|
|
=+ tod=(ape:ag ted:ab)
|
|
%+ bass 256
|
|
;~(plug tod (stun [3 3] ;~(pfix dot tod)))
|
|
::
|
|
(stag %site (cook crip (star ;~(pose dot alp))))
|
|
==
|
|
;~ pose
|
|
(stag ~ ;~(pfix col dim:ag))
|
|
(easy ~)
|
|
==
|
|
==
|
|
:: +per-client-event: per-event client core
|
|
::
|
|
++ per-client-event
|
|
|= [[our=@p eny=@ =duct now=@da scry=sley] state=state:client]
|
|
|%
|
|
:: +request: makes an external web request
|
|
::
|
|
++ request
|
|
|= [=http-request =outbound-config]
|
|
^- [(list move) state:client]
|
|
:: get the next id for this request
|
|
::
|
|
=^ id next-id.state [next-id.state +(next-id.state)]
|
|
:: add a new open session
|
|
::
|
|
=. connection-by-id.state
|
|
%+ ~(put by connection-by-id.state) id
|
|
=, outbound-config
|
|
[duct [redirects retries ~ ~ 0 ~]]
|
|
:: start the download
|
|
::
|
|
:: the original eyre keeps track of the duct on %born and then sends a
|
|
:: %give on that duct. this seems like a weird inversion of
|
|
:: responsibility, where we should instead be doing a pass to unix. the
|
|
:: reason we need to manually build ids is because we aren't using the
|
|
:: built in duct system.
|
|
::
|
|
:: email discussions make it sound like fixing that might be hard, so
|
|
:: maybe i should just live with the way it is now?
|
|
::
|
|
:- [outbound-duct.state %give %http-client %request id `http-request]~
|
|
state
|
|
:: +receive: receives a response to an http-request we made
|
|
::
|
|
:: TODO: Right now, we are not following redirect and not handling retries
|
|
:: correctly. We need to do this.
|
|
::
|
|
++ receive
|
|
|= [id=@ud =raw-http-response]
|
|
^- [(list move) state:client]
|
|
:: ensure that this is a valid receive
|
|
::
|
|
?~ connection=(~(get by connection-by-id.state) id)
|
|
~& [%eyre-unknown-receive id]
|
|
[~ state]
|
|
::
|
|
?- -.raw-http-response
|
|
%start
|
|
:: TODO: Handle redirects and retries here, before we start dispatching
|
|
:: back to the application.
|
|
::
|
|
:: record data from the http response that only comes from %start
|
|
::
|
|
=. connection-by-id.state
|
|
%+ ~(jab by connection-by-id.state) id
|
|
|= [duct=^duct =in-progress-http-request:client]
|
|
::
|
|
=. expected-size.in-progress-http-request
|
|
?~ str=(get-header 'content-length' headers.raw-http-response)
|
|
~
|
|
::
|
|
(rush u.str dum:ag)
|
|
::
|
|
=. response-headers.in-progress-http-request
|
|
`[status-code headers]:raw-http-response
|
|
::
|
|
[duct in-progress-http-request]
|
|
::
|
|
?: complete.raw-http-response
|
|
(send-finished id data.raw-http-response)
|
|
::
|
|
(record-and-send-progress id data.raw-http-response)
|
|
::
|
|
%continue
|
|
?: complete.raw-http-response
|
|
(send-finished id data.raw-http-response)
|
|
::
|
|
(record-and-send-progress id data.raw-http-response)
|
|
::
|
|
%cancel
|
|
~& [%eyre-received-cancel id]
|
|
[~ state]
|
|
==
|
|
:: +record-and-send-progress: save incoming data and send progress report
|
|
::
|
|
++ record-and-send-progress
|
|
|= [id=@ud data=(unit octs)]
|
|
^- [(list move) state:client]
|
|
::
|
|
=. connection-by-id.state
|
|
%+ ~(jab by connection-by-id.state) id
|
|
|= [duct=^duct =in-progress-http-request:client]
|
|
:: record the data chunk and size, if it exists
|
|
::
|
|
=? chunks.in-progress-http-request
|
|
?=(^ data)
|
|
[u.data chunks.in-progress-http-request]
|
|
=? bytes-read.in-progress-http-request
|
|
?=(^ data)
|
|
(add bytes-read.in-progress-http-request p.u.data)
|
|
::
|
|
[duct in-progress-http-request]
|
|
::
|
|
=/ connection (~(got by connection-by-id.state) id)
|
|
:_ state
|
|
^- (list move)
|
|
:_ ~
|
|
:* duct.connection
|
|
%give
|
|
%http-client
|
|
%progress
|
|
(need response-headers.in-progress-http-request.connection)
|
|
bytes-read.in-progress-http-request.connection
|
|
expected-size.in-progress-http-request.connection
|
|
data
|
|
==
|
|
:: +send-finished: sends the %finished, cleans up the session state
|
|
::
|
|
++ send-finished
|
|
|= [id=@ud data=(unit octs)]
|
|
^- [(list move) state:client]
|
|
::
|
|
=/ connection (~(got by connection-by-id.state) id)
|
|
:: reassemble the octs that we've received into their final form
|
|
::
|
|
=/ data=octs
|
|
%- combine-octs
|
|
%- flop
|
|
::
|
|
?~ data
|
|
chunks.in-progress-http-request.connection
|
|
[u.data chunks.in-progress-http-request.connection]
|
|
::
|
|
=/ response-headers=http-response-header
|
|
(need response-headers.in-progress-http-request.connection)
|
|
::
|
|
=/ mime=@t
|
|
?~ mime-type=(get-header 'content-type' headers.response-headers)
|
|
'application/octet-stream'
|
|
u.mime-type
|
|
:- :~ :* duct.connection
|
|
%give
|
|
%http-client
|
|
%finished
|
|
response-headers
|
|
?:(=(0 p.data) ~ `[mime data])
|
|
== ==
|
|
state(connection-by-id (~(del by connection-by-id.state) id))
|
|
--
|
|
:: +per-server-event: per-event server core
|
|
::
|
|
++ per-server-event
|
|
:: gate that produces the +per-server-event core from event information
|
|
::
|
|
|= [[our=@p eny=@ =duct now=@da scry=sley] state=server-state]
|
|
|%
|
|
:: +request: starts handling an inbound http request
|
|
::
|
|
++ request
|
|
|= [secure=? =address =http-request]
|
|
^- [(list move) server-state]
|
|
::
|
|
=+ host=(get-header 'host' header-list.http-request)
|
|
=+ action=(get-action-for-binding host url.http-request)
|
|
::
|
|
=/ authenticated (request-is-logged-in:authentication http-request)
|
|
:: record that we started an asynchronous response
|
|
::
|
|
=/ connection=outstanding-connection
|
|
[action [authenticated secure address http-request] ~ ~ 0]
|
|
=. connections.state
|
|
(~(put by connections.state) duct connection)
|
|
::
|
|
?- -.action
|
|
::
|
|
%gen
|
|
::
|
|
=- [[duct %pass /run-build %f %build live=%.n schematic=-]~ state]
|
|
::
|
|
=- [%cast [our desk.generator.action] %mime -]
|
|
::
|
|
:+ %call
|
|
:+ %call
|
|
[%core [[our desk.generator.action] (flop path.generator.action)]]
|
|
:: TODO: Figure out what goes in generators. We need to slop the
|
|
:: prelude with the arguments passed in.
|
|
::
|
|
[%$ %noun !>([[now=now eny=eny bek=[our desk.generator.action [%da now]]] ~ ~])]
|
|
[%$ %noun !>([authenticated http-request])]
|
|
::
|
|
%app
|
|
:_ state
|
|
:_ ~
|
|
:^ duct %pass /run-app/[app.action]
|
|
^- note
|
|
:^ %g %deal [our our]
|
|
:: todo: i don't entirely understand gall; there's a way to make a gall
|
|
:: use a %handle arm instead of a sub-%poke with the
|
|
:: %handle-http-request type.
|
|
::
|
|
^- cush:gall
|
|
:* app.action
|
|
%poke
|
|
%handle-http-request
|
|
!>(inbound-request.connection)
|
|
==
|
|
::
|
|
%authentication
|
|
(handle-request:authentication secure address http-request)
|
|
::
|
|
%channel
|
|
(handle-request:by-channel secure authenticated address http-request)
|
|
::
|
|
%four-oh-four
|
|
%^ return-static-data-on-duct 404 'text/html'
|
|
(file-not-found-page url.http-request)
|
|
==
|
|
:: +cancel-request: handles a request being externally aborted
|
|
::
|
|
++ cancel-request
|
|
^- [(list move) server-state]
|
|
::
|
|
?~ connection=(~(get by connections.state) duct)
|
|
:: nothing has handled this connection
|
|
::
|
|
[~ state]
|
|
::
|
|
=. connections.state (~(del by connections.state) duct)
|
|
::
|
|
?- -.action.u.connection
|
|
::
|
|
%gen
|
|
:_ state
|
|
[duct %pass /run-build %f %kill ~]~
|
|
::
|
|
%app
|
|
:_ state
|
|
:_ ~
|
|
:^ duct %pass /run-app/[app.action.u.connection]
|
|
^- note
|
|
:^ %g %deal [our our]
|
|
:: todo: i don't entirely understand gall; there's a way to make a gall
|
|
:: use a %handle arm instead of a sub-%poke with the
|
|
:: %handle-http-request type.
|
|
::
|
|
^- cush:gall
|
|
:* app.action.u.connection
|
|
%poke
|
|
%handle-http-cancel
|
|
!>(inbound-request.u.connection)
|
|
==
|
|
::
|
|
%authentication
|
|
[~ state]
|
|
::
|
|
%channel
|
|
on-cancel-request:by-channel
|
|
::
|
|
%four-oh-four
|
|
:: it should be impossible for a 404 page to be asynchronous
|
|
::
|
|
!!
|
|
==
|
|
:: +return-static-data-on-duct: returns one piece of data all at once
|
|
::
|
|
++ return-static-data-on-duct
|
|
|= [code=@ content-type=@t data=octs]
|
|
^- [(list move) server-state]
|
|
::
|
|
%- handle-response
|
|
:* %start
|
|
status-code=code
|
|
^= headers
|
|
:~ ['content-type' content-type]
|
|
['content-length' (crip (format-ud-as-integer p.data))]
|
|
==
|
|
data=[~ data]
|
|
complete=%.y
|
|
==
|
|
:: +authentication: per-event authentication as this Urbit's owner
|
|
::
|
|
:: Right now this hard codes the authentication page using the old +code
|
|
:: system, but in the future should be pluggable so we can use U2F or
|
|
:: WebAuthn or whatever is more secure than passwords.
|
|
::
|
|
++ authentication
|
|
|%
|
|
:: +handle-request: handles an http request for the
|
|
::
|
|
++ handle-request
|
|
|= [secure=? =address =http-request]
|
|
^- [(list move) server-state]
|
|
::
|
|
:: if we received a simple get, just return the page
|
|
::
|
|
?: =('GET' method.http-request)
|
|
:: parse the arguments out of request uri
|
|
::
|
|
=+ request-line=(parse-request-line url.http-request)
|
|
%^ return-static-data-on-duct 200 'text/html'
|
|
(login-page (get-header 'redirect' args.request-line))
|
|
:: if we are not a post, return an error
|
|
::
|
|
?. =('POST' method.http-request)
|
|
(return-static-data-on-duct 400 'text/html' (login-page ~))
|
|
:: we are a post, and must process the body type as form data
|
|
::
|
|
?~ body.http-request
|
|
(return-static-data-on-duct 400 'text/html' (login-page ~))
|
|
::
|
|
=/ parsed=(unit (list [key=@t value=@t]))
|
|
(rush q.u.body.http-request yquy:de-purl:html)
|
|
?~ parsed
|
|
(return-static-data-on-duct 400 'text/html' (login-page ~))
|
|
::
|
|
?~ password=(get-header 'password' u.parsed)
|
|
(return-static-data-on-duct 400 'text/html' (login-page ~))
|
|
:: check that the password is correct
|
|
::
|
|
?. =(u.password code)
|
|
(return-static-data-on-duct 400 'text/html' (login-page ~))
|
|
:: mint a unique session cookie
|
|
::
|
|
=/ session=@uv
|
|
|-
|
|
=/ candidate=@uv (~(raw og eny) 128)
|
|
?. (~(has by sessions.authentication-state.state) candidate)
|
|
candidate
|
|
$(eny (shas %try-again candidate))
|
|
:: record cookie and record expiry time
|
|
::
|
|
=. sessions.authentication-state.state
|
|
(~(put by sessions.authentication-state.state) session (add now ~h24))
|
|
::
|
|
=/ cookie-line
|
|
%- crip
|
|
"urbauth={<session>}; Path=/; Max-Age=86400"
|
|
::
|
|
=/ new-location=@t
|
|
?~ redirect=(get-header 'redirect' u.parsed)
|
|
'/'
|
|
u.redirect
|
|
::
|
|
%- handle-response
|
|
:* %start
|
|
status-code=307
|
|
^= headers
|
|
:~ ['location' new-location]
|
|
['set-cookie' cookie-line]
|
|
==
|
|
data=~
|
|
complete=%.y
|
|
==
|
|
:: +request-is-logged-in: checks to see if the request is authenticated
|
|
::
|
|
:: We are considered logged in if this http-request has an urbauth
|
|
:: Cookie which is not expired.
|
|
::
|
|
++ request-is-logged-in
|
|
|= =http-request
|
|
^- ?
|
|
:: are there cookies passed with this request?
|
|
::
|
|
:: TODO: In HTTP2, the client is allowed to put multiple 'Cookie'
|
|
:: headers.
|
|
::
|
|
?~ cookie-header=(get-header 'cookie' header-list.http-request)
|
|
%.n
|
|
:: is the cookie line is valid?
|
|
::
|
|
?~ cookies=(rush u.cookie-header cock:de-purl:html)
|
|
%.n
|
|
:: is there an urbauth cookie?
|
|
::
|
|
?~ urbauth=(get-header 'urbauth' u.cookies)
|
|
%.n
|
|
:: is this formatted like a valid session cookie?
|
|
::
|
|
?~ session-id=(rush u.urbauth ;~(pfix (jest '0v') viz:ag))
|
|
%.n
|
|
:: is this a session that we know about?
|
|
::
|
|
?~ session=(~(get by sessions.authentication-state.state) u.session-id)
|
|
%.n
|
|
:: is this session still valid?
|
|
::
|
|
(lte now expiry-time.u.session)
|
|
:: +code: returns the same as |code
|
|
::
|
|
:: This has the problem where the signature for sky vs sley.
|
|
::
|
|
++ code
|
|
^- @ta
|
|
'lidlut-tabwed-pillex-ridrup'
|
|
:: =+ pax=/(scot %p our)/code/(scot %da now)/(scot %p our)
|
|
:: %^ rsh 3 1
|
|
:: (scot %p (@ (need ((sloy scry) [151 %noun] %a pax))))
|
|
--
|
|
:: +channel: per-event handling of requests to the channel system
|
|
::
|
|
:: Eyre offers a remote interface to your Urbit through channels, which
|
|
:: are persistent connections on the server which
|
|
::
|
|
++ by-channel
|
|
:: moves: the moves to be sent out at the end of this event, reversed
|
|
::
|
|
=| moves=(list move)
|
|
|%
|
|
:: +handle-request: handles an http request for the subscription system
|
|
::
|
|
++ handle-request
|
|
|= [secure=? authenticated=? =address =http-request]
|
|
^- [(list move) server-state]
|
|
:: if we're not authenticated error, but don't redirect.
|
|
::
|
|
:: We don't redirect because subscription stuff is never the toplevel
|
|
:: page; issuing a redirect won't help.
|
|
::
|
|
?. authenticated
|
|
~& %unauthenticated
|
|
:: TODO: Real 400 page.
|
|
::
|
|
%^ return-static-data-on-duct 400 'text/html'
|
|
(internal-server-error authenticated url.http-request ~)
|
|
:: parse out the path key the subscription is on
|
|
::
|
|
=+ request-line=(parse-request-line url.http-request)
|
|
?. ?=([@t @t @t ~] site.request-line)
|
|
~& %bad-request-line
|
|
:: url is not of the form '/~/channel/'
|
|
::
|
|
%^ return-static-data-on-duct 400 'text/html'
|
|
(internal-server-error authenticated url.http-request ~)
|
|
:: channel-id: unique channel id parsed out of url
|
|
::
|
|
=+ channel-id=i.t.t.site.request-line
|
|
::
|
|
?: ?& =('channel' channel-id)
|
|
=([~ ~.js] ext.request-line)
|
|
==
|
|
:: client is requesting the javascript shim
|
|
::
|
|
(return-static-data-on-duct 200 'application/javascript' channel-js)
|
|
::
|
|
?: =('PUT' method.http-request)
|
|
:: PUT methods starts/modifies a channel, and returns a result immediately
|
|
::
|
|
(on-put-request channel-id http-request)
|
|
::
|
|
?: =('GET' method.http-request)
|
|
(on-get-request channel-id http-request)
|
|
::
|
|
~& %session-not-a-put
|
|
[~ state]
|
|
:: +on-cancel-request: cancels an ongoing subscription
|
|
::
|
|
:: One of our long lived sessions just got closed. We put the associated
|
|
:: session back into the waiting state.
|
|
::
|
|
++ on-cancel-request
|
|
^- [(list move) server-state]
|
|
:: lookup the session id by duct
|
|
::
|
|
?~ maybe-channel-id=(~(get by duct-to-key.channel-state.state) duct)
|
|
~& [%canceling-nonexistant-channel duct]
|
|
[~ state]
|
|
::
|
|
~& [%canceling-cancel duct]
|
|
::
|
|
=/ expiration-time=@da (add now channel-timeout)
|
|
::
|
|
:- [(set-timeout-move u.maybe-channel-id expiration-time) moves]
|
|
%_ state
|
|
session.channel-state
|
|
%+ ~(jab by session.channel-state.state) u.maybe-channel-id
|
|
|= =channel
|
|
:: if we are canceling a known channel, it should have a listener
|
|
::
|
|
?> ?=([%| *] state.channel)
|
|
channel(state [%& [expiration-time duct]])
|
|
::
|
|
duct-to-key.channel-state
|
|
(~(del by duct-to-key.channel-state.state) duct)
|
|
==
|
|
:: +set-timeout-timer-for: sets a timeout timer on a channel
|
|
::
|
|
:: This creates a channel if it doesn't exist, cancels existing timers
|
|
:: if they're already set (we cannot have duplicate timers), and (if
|
|
:: necessary) moves channels from the listening state to the expiration
|
|
:: state.
|
|
::
|
|
++ update-timeout-timer-for
|
|
|= channel-id=@t
|
|
^+ ..update-timeout-timer-for
|
|
:: when our callback should fire
|
|
::
|
|
=/ expiration-time=@da (add now channel-timeout)
|
|
:: if the channel doesn't exist, create it and set a timer
|
|
::
|
|
?~ maybe-channel=(~(get by session.channel-state.state) channel-id)
|
|
::
|
|
%_ ..update-timeout-timer-for
|
|
session.channel-state.state
|
|
%+ ~(put by session.channel-state.state) channel-id
|
|
[[%& expiration-time duct] 0 ~ ~]
|
|
::
|
|
moves
|
|
[(set-timeout-move channel-id expiration-time) moves]
|
|
==
|
|
:: if the channel has an active listener, we aren't setting any timers
|
|
::
|
|
?: ?=([%| *] state.u.maybe-channel)
|
|
..update-timeout-timer-for
|
|
:: we have a previous timer; cancel the old one and set the new one
|
|
::
|
|
%_ ..update-timeout-timer-for
|
|
session.channel-state.state
|
|
%+ ~(jab by session.channel-state.state) channel-id
|
|
|= =channel
|
|
channel(state [%& [expiration-time duct]])
|
|
::
|
|
moves
|
|
:* (cancel-timeout-move channel-id p.state.u.maybe-channel)
|
|
(set-timeout-move channel-id expiration-time)
|
|
moves
|
|
==
|
|
==
|
|
::
|
|
++ set-timeout-move
|
|
|= [channel-id=@t expiration-time=@da]
|
|
^- move
|
|
[duct %pass /channel/timeout/[channel-id] %b %wait expiration-time]
|
|
::
|
|
++ cancel-timeout-move
|
|
|= [channel-id=@t expiration-time=@da =^duct]
|
|
^- move
|
|
:^ duct %pass /channel/timeout/[channel-id]
|
|
[%b %rest expiration-time]
|
|
:: +on-get-request: handles a GET request
|
|
::
|
|
:: GET requests open a channel for the server to send events to the
|
|
:: client in text/event-stream format.
|
|
::
|
|
++ on-get-request
|
|
|= [channel-id=@t =http-request]
|
|
^- [(list move) server-state]
|
|
:: if there's no channel-id, we must 404
|
|
::
|
|
?~ maybe-channel=(~(get by session.channel-state.state) channel-id)
|
|
%^ return-static-data-on-duct 404 'text/html'
|
|
(internal-server-error %.y url.http-request ~)
|
|
:: if there's already a duct listening to this channel, we must 400
|
|
::
|
|
?: ?=([%| *] state.u.maybe-channel)
|
|
%^ return-static-data-on-duct 400 'text/html'
|
|
(internal-server-error %.y url.http-request ~)
|
|
:: when opening an event-stream, we must cancel our timeout timer
|
|
::
|
|
=. moves
|
|
[(cancel-timeout-move channel-id p.state.u.maybe-channel) moves]
|
|
:: the http-request may include a 'Last-Event-Id' header
|
|
::
|
|
=/ maybe-last-event-id=(unit @ud)
|
|
?~ maybe-raw-header=(get-header 'Last-Event-ID' header-list.http-request)
|
|
~
|
|
(rush u.maybe-raw-header dum:ag)
|
|
:: flush events older than the passed in 'Last-Event-ID'
|
|
::
|
|
=? state ?=(^ maybe-last-event-id)
|
|
(acknowledge-events channel-id u.maybe-last-event-id)
|
|
:: combine the remaining queued events to send to the client
|
|
::
|
|
=/ event-replay=wall
|
|
%- zing
|
|
%- flop
|
|
=/ queue events.u.maybe-channel
|
|
=| events=(list wall)
|
|
|-
|
|
^+ events
|
|
?: =(~ queue)
|
|
events
|
|
=^ head queue ~(get to queue)
|
|
$(events [lines.p.head events])
|
|
:: send the start event to the client
|
|
::
|
|
=^ http-moves state
|
|
%- handle-response
|
|
:* %start 200
|
|
:~ ['content-type' 'text/event-stream']
|
|
['cache-control' 'no-cache']
|
|
['connection' 'keep-alive']
|
|
==
|
|
(wall-to-octs event-replay)
|
|
complete=%.n
|
|
==
|
|
:: associate this duct with this session key
|
|
::
|
|
=. duct-to-key.channel-state.state
|
|
(~(put by duct-to-key.channel-state.state) duct channel-id)
|
|
:: clear the event queue and record the duct for future output
|
|
::
|
|
=. session.channel-state.state
|
|
%+ ~(jab by session.channel-state.state) channel-id
|
|
|= =channel
|
|
channel(events ~, state [%| duct])
|
|
::
|
|
[(weld http-moves moves) state]
|
|
:: +acknowledge-events: removes events before :last-event-id on :channel-id
|
|
::
|
|
++ acknowledge-events
|
|
|= [channel-id=@t last-event-id=@u]
|
|
^- server-state
|
|
%_ state
|
|
session.channel-state
|
|
%+ ~(jab by session.channel-state.state) channel-id
|
|
|= =channel
|
|
^+ channel
|
|
channel(events (prune-events events.channel last-event-id))
|
|
==
|
|
:: +on-put-request: handles a PUT request
|
|
::
|
|
:: PUT requests send commands from the client to the server. We receive
|
|
:: a set of commands in JSON format in the body of the message.
|
|
::
|
|
++ on-put-request
|
|
|= [channel-id=@t =http-request]
|
|
^- [(list move) server-state]
|
|
:: error when there's no body
|
|
::
|
|
?~ body.http-request
|
|
~& %no-body
|
|
%^ return-static-data-on-duct 400 'text/html'
|
|
(internal-server-error %.y url.http-request ~)
|
|
:: if the incoming body isn't json, this is a bad request, 400.
|
|
::
|
|
?~ maybe-json=(de-json:html q.u.body.http-request)
|
|
~& %no-json
|
|
%^ return-static-data-on-duct 400 'text/html'
|
|
(internal-server-error %.y url.http-request ~)
|
|
:: parse the json into an array of +channel-request items
|
|
::
|
|
?~ maybe-requests=(parse-channel-request u.maybe-json)
|
|
~& [%no-parse u.maybe-json]
|
|
%^ return-static-data-on-duct 400 'text/html'
|
|
(internal-server-error %.y url.http-request ~)
|
|
:: while weird, the request list could be empty
|
|
::
|
|
?: =(~ u.maybe-requests)
|
|
~& %empty-list
|
|
%^ return-static-data-on-duct 400 'text/html'
|
|
(internal-server-error %.y url.http-request ~)
|
|
:: check for the existence of the channel-id
|
|
::
|
|
:: if we have no session, create a new one set to expire in
|
|
:: :channel-timeout from now. if we have one which has a timer, update
|
|
:: that timer.
|
|
::
|
|
=. ..on-put-request (update-timeout-timer-for channel-id)
|
|
:: for each request, execute the action passed in
|
|
::
|
|
=+ requests=u.maybe-requests
|
|
:: gall-moves: put moves here first so we can flop for ordering
|
|
::
|
|
:: TODO: Have an error state where any invalid duplicate subscriptions
|
|
:: or other errors cause the entire thing to fail with a 400 and a tang.
|
|
::
|
|
=| gall-moves=(list move)
|
|
|-
|
|
::
|
|
?~ requests
|
|
:: this is a PUT request; we must mark it as complete
|
|
::
|
|
=^ http-moves state
|
|
%- handle-response
|
|
:* %start
|
|
status-code=200
|
|
headers=~
|
|
data=~
|
|
complete=%.y
|
|
==
|
|
::
|
|
[:(weld (flop gall-moves) http-moves moves) state]
|
|
::
|
|
?- -.i.requests
|
|
%ack
|
|
:: client acknowledges that they have received up to event-id
|
|
::
|
|
%_ $
|
|
state (acknowledge-events channel-id event-id.i.requests)
|
|
requests t.requests
|
|
==
|
|
::
|
|
%poke
|
|
::
|
|
=. gall-moves
|
|
:_ gall-moves
|
|
^- move
|
|
:^ duct %pass /channel/poke/[channel-id]/(scot %ud request-id.i.requests)
|
|
=, i.requests
|
|
[%g %deal `sock`[our ship] `cush:gall`[app %punk mark %json !>(json)]]
|
|
::
|
|
$(requests t.requests)
|
|
::
|
|
%subscribe
|
|
::
|
|
=. gall-moves
|
|
:_ gall-moves
|
|
^- move
|
|
:^ duct %pass
|
|
/channel/subscription/[channel-id]/(scot %ud request-id.i.requests)
|
|
=, i.requests
|
|
[%g %deal [our ship] `cush:gall`[app %peel %json path]]
|
|
:: TODO: Check existence to prevent duplicates?
|
|
::
|
|
=. session.channel-state.state
|
|
%+ ~(jab by session.channel-state.state) channel-id
|
|
|= =channel
|
|
^+ channel
|
|
=, i.requests
|
|
channel(subscriptions [[ship app path] subscriptions.channel])
|
|
::
|
|
$(requests t.requests)
|
|
::
|
|
%unsubscribe
|
|
!!
|
|
==
|
|
:: +on-gall-response: turns a gall response into an event
|
|
::
|
|
++ on-gall-response
|
|
|= [channel-id=@t request-id=@ud =cuft:gall]
|
|
^- [(list move) server-state]
|
|
::
|
|
?+ -.cuft ~|([%invalid-gall-response -.cuft] !!)
|
|
%coup
|
|
=/ =json
|
|
=, enjs:format
|
|
%- pairs :~
|
|
['response' [%s 'poke']]
|
|
['id' (numb request-id)]
|
|
?~ p.cuft
|
|
['ok' [%s 'ok']]
|
|
['err' (wall (render-tang-to-wall 100 u.p.cuft))]
|
|
==
|
|
::
|
|
(emit-event channel-id [(en-json:html json)]~)
|
|
::
|
|
%diff
|
|
=/ =json
|
|
=, enjs:format
|
|
%- pairs :~
|
|
['response' [%s 'diff']]
|
|
['id' (numb request-id)]
|
|
:- 'json'
|
|
?> =(%json p.p.cuft)
|
|
((hard json) q.q.p.cuft)
|
|
==
|
|
::
|
|
(emit-event channel-id [(en-json:html json)]~)
|
|
::
|
|
%quit
|
|
~& [%recieved-quit-from-gall channel-id]
|
|
=/ =json
|
|
=, enjs:format
|
|
%- pairs :~
|
|
['response' [%s 'quit']]
|
|
['id' (numb request-id)]
|
|
==
|
|
::
|
|
(emit-event channel-id [(en-json:html json)]~)
|
|
::
|
|
%reap
|
|
=/ =json
|
|
=, enjs:format
|
|
%- pairs :~
|
|
['response' [%s 'subscribe']]
|
|
['id' (numb request-id)]
|
|
?~ p.cuft
|
|
['ok' [%s 'ok']]
|
|
['err' (wall (render-tang-to-wall 100 u.p.cuft))]
|
|
==
|
|
::
|
|
(emit-event channel-id [(en-json:html json)]~)
|
|
==
|
|
:: +emit-event: records an event occurred, possibly sending to client
|
|
::
|
|
:: When an event occurs, we need to record it, even if we immediately
|
|
:: send it to a connected browser so in case of disconnection, we can
|
|
:: resend it.
|
|
::
|
|
:: This function is responsible for taking the raw json lines and
|
|
:: converting them into a text/event-stream. The :event-stream-lines
|
|
:: then may get sent, and are stored for later resending until
|
|
:: acknowledged by the client.
|
|
::
|
|
++ emit-event
|
|
|= [channel-id=@t json-text=wall]
|
|
^- [(list move) server-state]
|
|
::
|
|
=/ channel=channel
|
|
(~(got by session.channel-state.state) channel-id)
|
|
::
|
|
=/ event-id next-id.channel
|
|
::
|
|
=/ event-stream-lines=wall
|
|
%- weld :_ [""]~
|
|
:- (weld "id: " (format-ud-as-integer event-id))
|
|
%+ turn json-text
|
|
|= =tape
|
|
(weld "data: " tape)
|
|
:: if a client is connected, send this event to them.
|
|
::
|
|
=? moves ?=([%| *] state.channel)
|
|
:_ moves
|
|
:^ p.state.channel %give %http-server
|
|
:* %response %continue
|
|
::
|
|
^= data
|
|
:- ~
|
|
%- as-octs:mimes:html
|
|
(crip (of-wall:format event-stream-lines))
|
|
::
|
|
complete=%.n
|
|
==
|
|
::
|
|
:- moves
|
|
%_ state
|
|
session.channel-state
|
|
%+ ~(jab by session.channel-state.state) channel-id
|
|
|= =^channel
|
|
^+ channel
|
|
::
|
|
%_ channel
|
|
next-id +(next-id.channel)
|
|
events (~(put to events.channel) [event-id event-stream-lines])
|
|
==
|
|
==
|
|
:: +on-channel-timeout: we received a wake to clear an old session
|
|
::
|
|
++ on-channel-timeout
|
|
|= channel-id=@t
|
|
^- [(list move) server-state]
|
|
::
|
|
=/ session
|
|
(~(got by session.channel-state.state) channel-id)
|
|
::
|
|
:_ %_ state
|
|
session.channel-state
|
|
(~(del by session.channel-state.state) channel-id)
|
|
==
|
|
:: produce a list of moves which cancels every gall subscription
|
|
::
|
|
%+ turn subscriptions.session
|
|
|= [ship=@p app=term =path]
|
|
^- move
|
|
:: todo: double check this; which duct should we be canceling on? does
|
|
:: gall strongly bind to a duct as a cause like ford does?
|
|
::
|
|
:^ duct %pass /channel/subscription/[channel-id]
|
|
[%g %deal [our ship] app %pull ~]
|
|
--
|
|
:: +handle-ford-response: translates a ford response for the outside world
|
|
::
|
|
:: TODO: Get the authentication state and source url here.
|
|
::
|
|
++ handle-ford-response
|
|
|= made-result=made-result:ford
|
|
^- [(list move) server-state]
|
|
::
|
|
?: ?=(%incomplete -.made-result)
|
|
%^ return-static-data-on-duct 500 'text/html'
|
|
:: TODO: Thread original URL and authentication state here.
|
|
(internal-server-error %.y 'http://' tang.made-result)
|
|
::
|
|
?: ?=(%error -.build-result.made-result)
|
|
%^ return-static-data-on-duct 500 'text/html'
|
|
(internal-server-error %.y 'http://' message.build-result.made-result)
|
|
::
|
|
=/ =cage (result-to-cage:ford build-result.made-result)
|
|
::
|
|
%- handle-response
|
|
=/ result=mime ((hard mime) q.q.cage)
|
|
::
|
|
^- raw-http-response
|
|
:* %start
|
|
200
|
|
^- header-list
|
|
:~ ['content-type' (en-mite:mimes:html p.result)]
|
|
['content-length' (crip (format-ud-as-integer p.q.result))]
|
|
==
|
|
`(unit octs)`[~ q.result]
|
|
complete=%.y
|
|
==
|
|
:: +handle-response: check a response for correctness and send to earth
|
|
::
|
|
:: All outbound responses including %light generated responses need to go
|
|
:: through this interface because we want to have one centralized place
|
|
:: where we perform logging and state cleanup for connections that we're
|
|
:: done with.
|
|
::
|
|
++ handle-response
|
|
|= =raw-http-response
|
|
^- [(list move) server-state]
|
|
:: verify that this is a valid response on the duct
|
|
::
|
|
?~ connection-state=(~(get by connections.state) duct)
|
|
~& [%invalid-outstanding-connection duct]
|
|
[~ state]
|
|
::
|
|
|^ ^- [(list move) server-state]
|
|
::
|
|
?- -.raw-http-response
|
|
::
|
|
%start
|
|
?^ code.u.connection-state
|
|
~& [%http-multiple-start duct]
|
|
error-connection
|
|
::
|
|
=. connections.state
|
|
%+ ~(jab by connections.state) duct
|
|
|= connection=outstanding-connection
|
|
%_ connection
|
|
code `status-code.raw-http-response
|
|
headers `headers.raw-http-response
|
|
bytes-sent ?~(data.raw-http-response 0 p.u.data.raw-http-response)
|
|
==
|
|
::
|
|
=? state complete.raw-http-response
|
|
log-complete-request
|
|
::
|
|
pass-response
|
|
::
|
|
%continue
|
|
?~ code.u.connection-state
|
|
~& [%http-continue-without-start duct]
|
|
error-connection
|
|
::
|
|
=. connections.state
|
|
%+ ~(jab by connections.state) duct
|
|
|= connection=outstanding-connection
|
|
=+ size=?~(data.raw-http-response 0 p.u.data.raw-http-response)
|
|
connection(bytes-sent (add bytes-sent.connection size))
|
|
::
|
|
=? state complete.raw-http-response
|
|
log-complete-request
|
|
::
|
|
pass-response
|
|
::
|
|
%cancel
|
|
:: todo: log this differently from an ise.
|
|
::
|
|
error-connection
|
|
==
|
|
::
|
|
++ pass-response
|
|
^- [(list move) server-state]
|
|
[[duct %give %http-server %response raw-http-response]~ state]
|
|
::
|
|
++ log-complete-request
|
|
:: todo: log the complete request
|
|
::
|
|
:: remove all outstanding state for this connection
|
|
::
|
|
=. connections.state
|
|
(~(del by connections.state) duct)
|
|
state
|
|
::
|
|
++ error-connection
|
|
:: todo: log application error
|
|
::
|
|
:: remove all outstanding state for this connection
|
|
::
|
|
=. connections.state
|
|
(~(del by connections.state) duct)
|
|
:: respond to outside with %error
|
|
::
|
|
^- [(list move) server-state]
|
|
[[duct %give %http-server %response %cancel ~]~ state]
|
|
--
|
|
:: +add-binding: conditionally add a pairing between binding and action
|
|
::
|
|
:: Adds =binding =action if there is no conflicting bindings.
|
|
::
|
|
++ add-binding
|
|
|= [=binding =action]
|
|
::
|
|
=/ to-search bindings.state
|
|
|-
|
|
^- [(list move) server-state]
|
|
?~ to-search
|
|
:- [duct %give %http-server %bound %.y binding]~
|
|
=. bindings.state
|
|
:: store in reverse alphabetical order so that longer paths are first
|
|
::
|
|
%- flop
|
|
%+ sort [[binding duct action] bindings.state]
|
|
|= [[a=^binding *] [b=^binding *]]
|
|
::
|
|
?: =(site.a site.b)
|
|
(aor path.a path.b)
|
|
:: alphabetize based on site
|
|
::
|
|
(aor ?~(site.a '' u.site.a) ?~(site.b '' u.site.b))
|
|
state
|
|
::
|
|
?: =(binding binding.i.to-search)
|
|
:- [duct %give %http-server %bound %.n binding]~
|
|
state
|
|
::
|
|
$(to-search t.to-search)
|
|
:: +remove-binding: removes a binding if it exists and is owned by this duct
|
|
::
|
|
++ remove-binding
|
|
|= =binding
|
|
::
|
|
^- server-state
|
|
%_ state
|
|
bindings
|
|
%+ skip bindings.state
|
|
|= [item-binding=^binding item-duct=^duct =action]
|
|
^- ?
|
|
&(=(item-binding binding) =(item-duct duct))
|
|
==
|
|
:: +get-action-for-binding: finds an action for an incoming web request
|
|
::
|
|
++ get-action-for-binding
|
|
|= [raw-host=(unit @t) url=@t]
|
|
^- action
|
|
:: process :raw-host
|
|
::
|
|
:: If we are missing a 'Host:' header, if that header is a raw IP
|
|
:: address, or if the 'Host:' header refers to [our].urbit.org, we want
|
|
:: to return ~ which is the binding for our Urbit identity.
|
|
::
|
|
:: Otherwise, return the site given.
|
|
::
|
|
=/ host=(unit @t)
|
|
?~ raw-host
|
|
~
|
|
:: Parse the raw-host so that we can ignore ports, usernames, etc.
|
|
::
|
|
=+ parsed=(rush u.raw-host simplified-url-parser)
|
|
?~ parsed
|
|
~
|
|
:: if the url is a raw IP, assume default site.
|
|
::
|
|
?: ?=([%ip *] -.u.parsed)
|
|
~
|
|
:: if the url is "localhost", assume default site.
|
|
::
|
|
?: =([%site 'localhost'] -.u.parsed)
|
|
~
|
|
:: render our as a tape, and cut off the sig in front.
|
|
::
|
|
=/ with-sig=tape (scow %p our)
|
|
?> ?=(^ with-sig)
|
|
?: =(u.raw-host (crip t.with-sig))
|
|
:: [our].urbit.org is the default site
|
|
::
|
|
~
|
|
::
|
|
raw-host
|
|
:: url is the raw thing passed over the 'Request-Line'.
|
|
::
|
|
:: todo: this is really input validation, and we should return a 500 to
|
|
:: the client.
|
|
::
|
|
=/ request-line (parse-request-line url)
|
|
=/ parsed-url=(list @t) site.request-line
|
|
::
|
|
=/ bindings bindings.state
|
|
|-
|
|
::
|
|
?~ bindings
|
|
[%four-oh-four ~]
|
|
::
|
|
?: (path-matches path.binding.i.bindings parsed-url)
|
|
action.i.bindings
|
|
::
|
|
$(bindings t.bindings)
|
|
--
|
|
::
|
|
::
|
|
++ parse-request-line
|
|
|= url=@t
|
|
^- [[ext=(unit @ta) site=(list @t)] args=(list [key=@t value=@t])]
|
|
(fall (rush url ;~(plug apat:de-purl:html yque:de-purl:html)) [[~ ~] ~])
|
|
--
|
|
:: end the =~
|
|
::
|
|
. ==
|
|
:: begin with a default +axle as a blank slate
|
|
::
|
|
=| ax=axle
|
|
:: a vane is activated with current date, entropy, and a namespace function
|
|
::
|
|
|= [our=ship now=@da eny=@uvJ scry-gate=sley]
|
|
:: allow jets to be registered within this core
|
|
::
|
|
~% %light ..is ~
|
|
|%
|
|
++ call
|
|
|= [=duct type=* wrapped-task=(hobo task:able)]
|
|
^- [(list move) _light-gate]
|
|
::
|
|
=/ task=task:able
|
|
?. ?=(%soft -.wrapped-task)
|
|
wrapped-task
|
|
~| [%p-wrapped-task p.wrapped-task]
|
|
((hard task:able) p.wrapped-task)
|
|
::
|
|
?- -.task
|
|
:: %init: tells us what our ship name is
|
|
::
|
|
%init
|
|
:: initial value for the login handler
|
|
::
|
|
=. bindings.server-state.ax
|
|
:~ [[~ /~/login] duct [%authentication ~]]
|
|
[[~ /~/channel] duct [%channel ~]]
|
|
==
|
|
[~ light-gate]
|
|
:: %born: new unix process
|
|
::
|
|
%born
|
|
::
|
|
~& [%todo-handle-born p.task]
|
|
:: TODO: reset the next-id for client state here.
|
|
::
|
|
:: send requests on the duct passed in with born.
|
|
::
|
|
=. outbound-duct.client-state.ax duct
|
|
:: close previously open connections
|
|
::
|
|
:: When we have a new unix process, every outstanding open connection is
|
|
:: dead. For every duct, send an implicit close connection.
|
|
::
|
|
=^ closed-connections=(list move) server-state.ax
|
|
=/ connections=(list [=^duct *])
|
|
~(tap by connections.server-state.ax)
|
|
::
|
|
=| closed-connections=(list move)
|
|
|-
|
|
?~ connections
|
|
[closed-connections server-state.ax]
|
|
::
|
|
=/ event-args
|
|
[[our eny duct.i.connections now scry-gate] server-state.ax]
|
|
=/ cancel-request cancel-request:(per-server-event event-args)
|
|
=^ moves server-state.ax cancel-request
|
|
::
|
|
$(closed-connections (weld moves closed-connections), connections t.connections)
|
|
::
|
|
:_ light-gate
|
|
;: weld
|
|
:: hand back default configuration for now
|
|
::
|
|
[duct %give %http-server %set-config *http-config]~
|
|
::
|
|
closed-connections
|
|
==
|
|
::
|
|
::
|
|
::
|
|
%http-server
|
|
=/ event-args [[our eny duct now scry-gate] server-state.ax]
|
|
=/ server (per-server-event event-args)
|
|
?- -.server-task.task
|
|
::
|
|
:: %live: no idea what this is for
|
|
::
|
|
%live
|
|
::
|
|
~! task
|
|
~& [%todo-live server-task.task]
|
|
::
|
|
[~ light-gate]
|
|
::
|
|
%request
|
|
=^ moves server-state.ax (request:server +.server-task.task)
|
|
[moves light-gate]
|
|
::
|
|
%cancel-request
|
|
=^ moves server-state.ax cancel-request:server
|
|
[moves light-gate]
|
|
::
|
|
%connect
|
|
=^ moves server-state.ax
|
|
%+ add-binding:server binding.server-task.task
|
|
[%app app.server-task.task]
|
|
[moves light-gate]
|
|
::
|
|
%serve
|
|
=^ moves server-state.ax
|
|
%+ add-binding:server binding.server-task.task
|
|
[%gen generator.server-task.task]
|
|
[moves light-gate]
|
|
::
|
|
%disconnect
|
|
=. server-state.ax (remove-binding:server binding.server-task.task)
|
|
[~ light-gate]
|
|
==
|
|
::
|
|
::
|
|
::
|
|
%http-client
|
|
=/ event-args [[our eny duct now scry-gate] client-state.ax]
|
|
=/ client (per-client-event event-args)
|
|
?- -.client-task.task
|
|
::
|
|
%request
|
|
=^ moves client-state.ax (request:client +.client-task.task)
|
|
[moves light-gate]
|
|
::
|
|
%cancel-request
|
|
~& %todo-cancel-request
|
|
[~ light-gate]
|
|
::
|
|
%receive
|
|
=^ moves client-state.ax (receive:client +.client-task.task)
|
|
[moves light-gate]
|
|
==
|
|
==
|
|
::
|
|
++ take
|
|
|= [=wire =duct wrapped-sign=(hypo sign)]
|
|
^- [(list move) _light-gate]
|
|
:: unwrap :sign, ignoring unneeded +type in :p.wrapped-sign
|
|
::
|
|
=/ =sign q.wrapped-sign
|
|
:: :wire must at least contain two parts, the type and the build
|
|
::
|
|
?> ?=([@ *] wire)
|
|
::
|
|
|^ ^- [(list move) _light-gate]
|
|
::
|
|
?+ i.wire
|
|
~|([%bad-take-wire wire] !!)
|
|
::
|
|
%run-app run-app
|
|
%run-build run-build
|
|
%channel channel
|
|
==
|
|
::
|
|
++ run-app
|
|
::
|
|
?. ?=([%g %unto %http-response *] sign)
|
|
:: entirely normal to get things other than http-response calls, but we
|
|
:: don't care.
|
|
::
|
|
[~ light-gate]
|
|
::
|
|
=/ event-args [[our eny duct now scry-gate] server-state.ax]
|
|
=/ handle-response handle-response:(per-server-event event-args)
|
|
=^ moves server-state.ax (handle-response raw-http-response.p.sign)
|
|
[moves light-gate]
|
|
::
|
|
++ run-build
|
|
::
|
|
?> ?=([%f %made *] sign)
|
|
::
|
|
=/ event-args [[our eny duct now scry-gate] server-state.ax]
|
|
=/ handle-ford-response handle-ford-response:(per-server-event event-args)
|
|
=^ moves server-state.ax (handle-ford-response result.sign)
|
|
[moves light-gate]
|
|
::
|
|
++ channel
|
|
::
|
|
=/ event-args [[our eny duct now scry-gate] server-state.ax]
|
|
:: channel callback wires are triples.
|
|
::
|
|
?> ?=([@ @ @t *] wire)
|
|
::
|
|
?+ i.t.wire
|
|
~|([%bad-channel-wire wire] !!)
|
|
::
|
|
%timeout
|
|
=/ on-channel-timeout
|
|
on-channel-timeout:by-channel:(per-server-event event-args)
|
|
=^ moves server-state.ax
|
|
(on-channel-timeout i.t.t.wire)
|
|
[moves light-gate]
|
|
::
|
|
:: %wake
|
|
:: [~ move
|
|
::
|
|
?(%poke %subscription)
|
|
?> ?=([%g %unto *] sign)
|
|
?> ?=([@ @ @t @ *] wire)
|
|
=/ on-gall-response
|
|
on-gall-response:by-channel:(per-server-event event-args)
|
|
:: ~& [%gall-response sign]
|
|
=^ moves server-state.ax
|
|
(on-gall-response i.t.t.wire `@ud`(slav %ud i.t.t.t.wire) p.sign)
|
|
[moves light-gate]
|
|
==
|
|
--
|
|
::
|
|
++ light-gate ..$
|
|
:: +load: migrate old state to new state (called on vane reload)
|
|
::
|
|
++ load
|
|
|= old=axle
|
|
^+ ..^$
|
|
::
|
|
~! %loading
|
|
..^$(ax old)
|
|
:: +stay: produce current state
|
|
::
|
|
++ stay `axle`ax
|
|
:: +scry: request a path in the urbit namespace
|
|
::
|
|
++ scry
|
|
|= *
|
|
[~ ~]
|
|
--
|