Noah Petherbridge
38614ee280
* Tightens up the surface area of API methods available to the JavaScript VMs for doodads. Variables and functions are carefully passed in one-by-one so the doodad script can only access intended functions and not snoop on undocumented APIs. * Wrote tons of user documentation for Doodad Scripts: documented the full surface area of the exposed JavaScript API now that the surface area is known and limited. * Early WIP code for the Campaign JSON
100 lines
2.2 KiB
Go
100 lines
2.2 KiB
Go
package scripting
|
|
|
|
import (
|
|
"fmt"
|
|
"sync"
|
|
|
|
"git.kirsle.net/apps/doodle/pkg/log"
|
|
"github.com/robertkrimen/otto"
|
|
)
|
|
|
|
// VM manages a single isolated JavaScript VM.
|
|
type VM struct {
|
|
Name string
|
|
|
|
// Globals available to the scripts.
|
|
Events *Events
|
|
Self interface{}
|
|
|
|
// Channels for inbound and outbound PubSub messages.
|
|
// Each VM has a single Inbound channel that watches for received messages
|
|
// and invokes the Message.Subscribe() handlers for relevant ones.
|
|
// Each VM also has an array of Outbound channels which map to the Inbound
|
|
// channel of the VMs it is linked to, for pushing out Message.Publish()
|
|
// messages.
|
|
Inbound chan Message
|
|
Outbound []chan Message
|
|
subscribe map[string][]otto.Value // Subscribed message handlers by name.
|
|
muSubscribe sync.RWMutex
|
|
|
|
vm *otto.Otto
|
|
|
|
// setTimeout and setInterval variables.
|
|
timerLastID int // becomes 1 when first timer is set
|
|
timers map[int]*Timer
|
|
}
|
|
|
|
// NewVM creates a new JavaScript VM.
|
|
func NewVM(name string) *VM {
|
|
vm := &VM{
|
|
Name: name,
|
|
Events: NewEvents(),
|
|
vm: otto.New(),
|
|
timers: map[int]*Timer{},
|
|
|
|
// Pub/sub structs.
|
|
Inbound: make(chan Message),
|
|
Outbound: []chan Message{},
|
|
subscribe: map[string][]otto.Value{},
|
|
}
|
|
return vm
|
|
}
|
|
|
|
// Run code in the VM.
|
|
func (vm *VM) Run(src interface{}) (otto.Value, error) {
|
|
v, err := vm.vm.Run(src)
|
|
return v, err
|
|
}
|
|
|
|
// Set a value in the VM.
|
|
func (vm *VM) Set(name string, v interface{}) error {
|
|
return vm.vm.Set(name, v)
|
|
}
|
|
|
|
// RegisterLevelHooks registers accessors to the level hooks
|
|
// and Doodad API for Play Mode.
|
|
func (vm *VM) RegisterLevelHooks() error {
|
|
bindings := NewJSProxy(vm)
|
|
for name, v := range bindings {
|
|
err := vm.vm.Set(name, v)
|
|
if err != nil {
|
|
return fmt.Errorf("RegisterLevelHooks(%s): %s",
|
|
name, err,
|
|
)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Main calls the main function of the script.
|
|
func (vm *VM) Main() error {
|
|
function, err := vm.vm.Get("main")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if !function.IsFunction() {
|
|
return nil
|
|
}
|
|
|
|
// Catch panics.
|
|
defer func() {
|
|
if err := recover(); err != nil {
|
|
log.Error("Panic caught in JavaScript VM: %s", err)
|
|
}
|
|
}()
|
|
|
|
_, err = function.Call(otto.Value{})
|
|
return err
|
|
}
|