darwin.go 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454
  1. //go:build darwin && (amd64 || arm64)
  2. package nativehost
  3. import (
  4. "encoding/json"
  5. "fmt"
  6. "unsafe"
  7. "clusterflow.dev/cfbrowser/api"
  8. "clusterflow.dev/cfbrowser/internal/capture"
  9. "clusterflow.dev/cfbrowser/protocol"
  10. "github.com/ebitengine/purego"
  11. "github.com/ebitengine/purego/objc"
  12. )
  13. type cocoaPoint struct{ X, Y float64 }
  14. type cocoaSize struct{ Width, Height float64 }
  15. type cocoaRect struct {
  16. Origin cocoaPoint
  17. Size cocoaSize
  18. }
  19. func selector(name string) objc.SEL { return objc.RegisterName(name) }
  20. func send(id objc.ID, name string, args ...any) objc.ID { return id.Send(selector(name), args...) }
  21. func class(name string) objc.ID { return objc.ID(objc.GetClass(name)) }
  22. func retain(id objc.ID) objc.ID { return send(id, "retain") }
  23. func release(id objc.ID) {
  24. if id != 0 {
  25. send(id, "release")
  26. }
  27. }
  28. func nsString(s string) objc.ID { return send(class("NSString"), "stringWithUTF8String:", s) }
  29. // Objective-C blocks contain only a numeric token, never a Go heap pointer.
  30. // The framework copies the heap block; its final release belongs to WebKit.
  31. type objcBlock struct {
  32. Isa uintptr
  33. Flags, Reserved int32
  34. Invoke uintptr
  35. Descriptor unsafe.Pointer
  36. Token uint64
  37. }
  38. type blockDescriptor struct {
  39. Reserved, Size uintptr
  40. Signature unsafe.Pointer
  41. }
  42. type cocoaPage struct {
  43. view, window, delegate, navigation objc.ID
  44. navigate func(string, error)
  45. blocks map[uint64]bool
  46. }
  47. type Darwin struct {
  48. options api.EngineOptions
  49. app, pool, store, world, mode objc.ID
  50. delegateClass objc.Class
  51. pages map[uint64]*cocoaPage
  52. byView map[objc.ID]*cocoaPage
  53. blocks map[uint64]func(objc.ID, objc.ID)
  54. nextBlock uint64
  55. blockISA, blockInvoke uintptr
  56. descriptor unsafe.Pointer
  57. malloc func(uintptr) unsafe.Pointer
  58. free func(unsafe.Pointer)
  59. copyBlock func(unsafe.Pointer) unsafe.Pointer
  60. releaseBlock func(unsafe.Pointer)
  61. closed bool
  62. }
  63. // NewDarwin must execute on the process main OS thread, pinned in main.init.
  64. func NewDarwin() (*Darwin, error) {
  65. for _, path := range []string{"/System/Library/Frameworks/Cocoa.framework/Cocoa", "/System/Library/Frameworks/WebKit.framework/WebKit"} {
  66. if _, err := purego.Dlopen(path, purego.RTLD_NOW|purego.RTLD_GLOBAL); err != nil {
  67. return nil, api.Err("BROWSER_RUNTIME_UNAVAILABLE", err.Error())
  68. }
  69. }
  70. d := &Darwin{pages: map[uint64]*cocoaPage{}, byView: map[objc.ID]*cocoaPage{}, blocks: map[uint64]func(objc.ID, objc.ID){}}
  71. d.pool = send(class("NSAutoreleasePool"), "new")
  72. if !objc.Send[bool](class("NSThread"), selector("isMainThread")) {
  73. d.Close()
  74. return nil, api.Err("BROWSER_RUNTIME_UNAVAILABLE", "WKWebView requires the process main thread")
  75. }
  76. if objc.GetClass("WKContentWorld") == 0 {
  77. d.Close()
  78. return nil, api.Err("BROWSER_RUNTIME_UNAVAILABLE", "WKWebView isolated worlds require macOS 11 or later")
  79. }
  80. if err := d.initBlocks(); err != nil {
  81. d.Close()
  82. return nil, err
  83. }
  84. var err error
  85. d.delegateClass, err = objc.RegisterClass("CFBrowserNavigationDelegate", objc.GetClass("NSObject"), nil, nil, []objc.MethodDef{
  86. {Cmd: selector("webView:didFinishNavigation:"), Fn: func(_ objc.ID, _ objc.SEL, view, nav objc.ID) { d.finishNavigation(view, nav, 0) }},
  87. {Cmd: selector("webView:didFailNavigation:withError:"), Fn: func(_ objc.ID, _ objc.SEL, view, nav, exception objc.ID) { d.finishNavigation(view, nav, exception) }},
  88. {Cmd: selector("webView:didFailProvisionalNavigation:withError:"), Fn: func(_ objc.ID, _ objc.SEL, view, nav, exception objc.ID) { d.finishNavigation(view, nav, exception) }},
  89. {Cmd: selector("webViewWebContentProcessDidTerminate:"), Fn: func(_ objc.ID, _ objc.SEL, view objc.ID) {
  90. if p := d.byView[view]; p != nil && p.navigate != nil {
  91. fn := p.navigate
  92. p.navigate = nil
  93. fn("", api.Err("BROWSER_WORKER_EXITED", "WebKit content process terminated"))
  94. }
  95. }},
  96. })
  97. if err != nil {
  98. d.Close()
  99. return nil, err
  100. }
  101. d.app = send(class("NSApplication"), "sharedApplication")
  102. send(d.app, "setActivationPolicy:", int64(1))
  103. send(d.app, "finishLaunching")
  104. d.mode = retain(nsString("kCFRunLoopDefaultMode"))
  105. d.store = retain(send(class("WKWebsiteDataStore"), "nonPersistentDataStore"))
  106. d.world = retain(send(class("WKContentWorld"), "worldWithName:", nsString("cfbrowser-isolated")))
  107. return d, nil
  108. }
  109. func (d *Darwin) Configure(opts api.EngineOptions, done func(error)) { d.options = opts; done(nil) }
  110. func (d *Darwin) NewPage(id uint64, done func(error)) {
  111. configuration := send(class("WKWebViewConfiguration"), "new")
  112. defer release(configuration)
  113. send(configuration, "setWebsiteDataStore:", d.store)
  114. preferences := send(configuration, "preferences")
  115. send(preferences, "setJavaScriptCanOpenWindowsAutomatically:", false)
  116. controller := send(configuration, "userContentController")
  117. // A script retains the named world across separate evaluations and snapshots.
  118. script := send(send(class("WKUserScript"), "alloc"), "initWithSource:injectionTime:forMainFrameOnly:inContentWorld:", nsString("void 0"), int64(0), true, d.world)
  119. send(controller, "addUserScript:", script)
  120. release(script)
  121. frame := cocoaRect{Size: cocoaSize{float64(d.options.ViewportWidth), float64(d.options.ViewportHeight)}}
  122. view := send(send(class("WKWebView"), "alloc"), "initWithFrame:configuration:", frame, configuration)
  123. if view == 0 {
  124. done(api.Err("BROWSER_RUNTIME_UNAVAILABLE", "cannot create WKWebView"))
  125. return
  126. }
  127. delegate := send(objc.ID(d.delegateClass), "new")
  128. send(view, "setNavigationDelegate:", delegate)
  129. window := send(send(class("NSWindow"), "alloc"), "initWithContentRect:styleMask:backing:defer:", frame, uint64(1|2|8), uint64(2), false)
  130. if window == 0 {
  131. send(view, "setNavigationDelegate:", objc.ID(0))
  132. release(delegate)
  133. release(view)
  134. done(api.Err("BROWSER_RUNTIME_UNAVAILABLE", "cannot create WebKit host window"))
  135. return
  136. }
  137. send(window, "setReleasedWhenClosed:", false)
  138. send(window, "setTitle:", nsString("CFBrowser"))
  139. send(window, "setContentView:", view)
  140. p := &cocoaPage{view: view, window: window, delegate: delegate, blocks: map[uint64]bool{}}
  141. d.pages[id] = p
  142. d.byView[view] = p
  143. if !d.options.Headless {
  144. send(window, "orderFront:", objc.ID(0))
  145. }
  146. done(nil)
  147. }
  148. func (d *Darwin) finishNavigation(view, nav, exception objc.ID) {
  149. p := d.byView[view]
  150. if p == nil || p.navigate == nil || nav != p.navigation {
  151. return
  152. }
  153. fn := p.navigate
  154. p.navigate = nil
  155. if exception != 0 {
  156. fn("", d.nativeError(exception, "BROWSER_NAVIGATION_FAILED"))
  157. return
  158. }
  159. url, err := d.string(send(send(view, "URL"), "absoluteString"), 8192)
  160. fn(url, err)
  161. }
  162. func (d *Darwin) Navigate(id uint64, url, op string, done func(string, error)) {
  163. p := d.pages[id]
  164. if p == nil {
  165. done("", api.Err("BROWSER_PAGE_NOT_FOUND", "WKWebView page is closed"))
  166. return
  167. }
  168. if p.navigate != nil {
  169. fn := p.navigate
  170. p.navigate = nil
  171. send(p.view, "stopLoading")
  172. fn("", api.Err("BROWSER_CANCELED", "navigation superseded"))
  173. }
  174. if op == "back" || op == "forward" {
  175. name := "canGoBack"
  176. if op == "forward" {
  177. name = "canGoForward"
  178. }
  179. if !objc.Send[bool](p.view, selector(name)) {
  180. s, err := d.string(send(send(p.view, "URL"), "absoluteString"), 8192)
  181. done(s, err)
  182. return
  183. }
  184. }
  185. p.navigate = done
  186. switch op {
  187. case "goto":
  188. u := send(class("NSURL"), "URLWithString:", nsString(url))
  189. if u == 0 {
  190. p.navigate = nil
  191. done("", api.Err("BROWSER_INVALID_ARGUMENT", "invalid URL"))
  192. return
  193. }
  194. request := send(class("NSURLRequest"), "requestWithURL:", u)
  195. p.navigation = send(p.view, "loadRequest:", request)
  196. case "reload":
  197. p.navigation = send(p.view, "reload")
  198. case "back":
  199. p.navigation = send(p.view, "goBack")
  200. case "forward":
  201. p.navigation = send(p.view, "goForward")
  202. default:
  203. p.navigate = nil
  204. done("", api.Err("BROWSER_INVALID_ARGUMENT", "invalid navigation operation"))
  205. return
  206. }
  207. if p.navigation == 0 {
  208. p.navigate = nil
  209. done("", api.Err("BROWSER_NAVIGATION_FAILED", "WKWebView returned no navigation"))
  210. }
  211. }
  212. func (d *Darwin) completion(p *cocoaPage, fn func(objc.ID, objc.ID)) (unsafe.Pointer, error) {
  213. if len(d.blocks) >= 32 {
  214. return nil, api.Err("BROWSER_LIMIT", "too many native evaluations pending")
  215. }
  216. d.nextBlock++
  217. token := d.nextBlock
  218. literal := d.malloc(unsafe.Sizeof(objcBlock{}))
  219. if literal == nil {
  220. return nil, fmt.Errorf("cannot allocate completion block")
  221. }
  222. *(*objcBlock)(literal) = objcBlock{Isa: d.blockISA, Flags: 1 << 30, Invoke: d.blockInvoke, Descriptor: d.descriptor, Token: token}
  223. block := d.copyBlock(literal)
  224. d.free(literal)
  225. if block == nil {
  226. return nil, fmt.Errorf("cannot copy completion block")
  227. }
  228. p.blocks[token] = true
  229. d.blocks[token] = func(value, exception objc.ID) { delete(p.blocks, token); fn(value, exception) }
  230. return block, nil
  231. }
  232. func (d *Darwin) Evaluate(id uint64, expression string, done func(json.RawMessage, error)) {
  233. p := d.pages[id]
  234. if p == nil {
  235. done(nil, api.Err("BROWSER_PAGE_NOT_FOUND", "WKWebView page is closed"))
  236. return
  237. }
  238. block, err := d.completion(p, func(value, exception objc.ID) {
  239. if d.pages[id] != p {
  240. done(nil, api.Err("BROWSER_CLOSED", "page closed during evaluation"))
  241. return
  242. }
  243. if exception != 0 {
  244. done(nil, d.nativeError(exception, "BROWSER_SCRIPT_FAILED"))
  245. return
  246. }
  247. valueString, e := d.string(value, protocol.MaxMessage-1024)
  248. if e == nil && !json.Valid([]byte(valueString)) {
  249. e = api.Err("BROWSER_INVALID_RESULT", "WKWebView evaluation returned no JSON value")
  250. }
  251. done(json.RawMessage(valueString), e)
  252. })
  253. if err != nil {
  254. done(nil, err)
  255. return
  256. }
  257. send(p.view, "evaluateJavaScript:inFrame:inContentWorld:completionHandler:", nsString("JSON.stringify(("+expression+"))"), objc.ID(0), d.world, block)
  258. d.releaseBlock(block)
  259. }
  260. func (d *Darwin) string(value objc.ID, limit int) (string, error) {
  261. if value == 0 {
  262. return "", nil
  263. }
  264. if !objc.Send[bool](value, selector("isKindOfClass:"), objc.GetClass("NSString")) {
  265. return "", api.Err("BROWSER_INVALID_RESULT", "expected an NSString result")
  266. }
  267. ptr := objc.Send[*byte](value, selector("UTF8String"))
  268. if ptr == nil {
  269. return "", nil
  270. }
  271. for i := 0; i <= limit; i++ {
  272. if *(*byte)(unsafe.Add(unsafe.Pointer(ptr), i)) == 0 {
  273. return string(unsafe.Slice(ptr, i)), nil
  274. }
  275. }
  276. return "", api.Err("BROWSER_RESULT_LIMIT", "WKWebView string exceeds worker limit")
  277. }
  278. func (d *Darwin) nativeError(value objc.ID, code string) error {
  279. s, err := d.string(send(value, "localizedDescription"), 4096)
  280. if err != nil || s == "" {
  281. s = "WKWebView operation failed"
  282. }
  283. return api.Err(code, s)
  284. }
  285. func (d *Darwin) ClosePage(id uint64) error {
  286. p := d.pages[id]
  287. if p == nil {
  288. return nil
  289. }
  290. delete(d.pages, id)
  291. delete(d.byView, p.view)
  292. for token := range p.blocks {
  293. delete(d.blocks, token)
  294. }
  295. if p.navigate != nil {
  296. fn := p.navigate
  297. p.navigate = nil
  298. fn("", api.Err("BROWSER_CLOSED", "page closed"))
  299. }
  300. send(p.view, "stopLoading")
  301. send(p.view, "setNavigationDelegate:", objc.ID(0))
  302. send(p.view, "removeFromSuperview")
  303. send(p.window, "close")
  304. release(p.view)
  305. release(p.delegate)
  306. release(p.window)
  307. return nil
  308. }
  309. func (d *Darwin) Pump() error {
  310. release(d.pool)
  311. d.pool = send(class("NSAutoreleasePool"), "new")
  312. for i := 0; i < 100; i++ {
  313. event := send(d.app, "nextEventMatchingMask:untilDate:inMode:dequeue:", ^uint64(0), send(class("NSDate"), "distantPast"), d.mode, true)
  314. if event == 0 {
  315. break
  316. }
  317. send(d.app, "sendEvent:", event)
  318. }
  319. send(d.app, "updateWindows")
  320. return nil
  321. }
  322. func (d *Darwin) Close() {
  323. if d.closed {
  324. return
  325. }
  326. d.closed = true
  327. for id := range d.pages {
  328. _ = d.ClosePage(id)
  329. }
  330. clear(d.blocks)
  331. release(d.world)
  332. release(d.store)
  333. release(d.mode)
  334. release(d.pool)
  335. d.world = 0
  336. d.store = 0
  337. d.mode = 0
  338. d.pool = 0
  339. }
  340. func (d *Darwin) initBlocks() error {
  341. lib, err := purego.Dlopen("/usr/lib/libSystem.B.dylib", purego.RTLD_NOW|purego.RTLD_GLOBAL)
  342. if err != nil {
  343. return err
  344. }
  345. purego.RegisterLibFunc(&d.malloc, lib, "malloc")
  346. purego.RegisterLibFunc(&d.free, lib, "free")
  347. purego.RegisterLibFunc(&d.copyBlock, lib, "_Block_copy")
  348. purego.RegisterLibFunc(&d.releaseBlock, lib, "_Block_release")
  349. d.blockISA, err = purego.Dlsym(lib, "_NSConcreteStackBlock")
  350. if err != nil {
  351. return err
  352. }
  353. d.blockInvoke = purego.NewCallback(func(block *objcBlock, value, exception objc.ID) {
  354. fn := d.blocks[block.Token]
  355. delete(d.blocks, block.Token)
  356. if fn != nil && !d.closed {
  357. fn(value, exception)
  358. }
  359. })
  360. // Descriptor/signature live until process exit; pending WebKit blocks can outlive Close.
  361. d.descriptor = d.malloc(unsafe.Sizeof(blockDescriptor{}))
  362. if d.descriptor == nil {
  363. return fmt.Errorf("cannot allocate block descriptor")
  364. }
  365. const encoding = "v24@?0@8@16\x00"
  366. signature := d.malloc(uintptr(len(encoding)))
  367. if signature == nil {
  368. return fmt.Errorf("cannot allocate block signature")
  369. }
  370. copy(unsafe.Slice((*byte)(signature), len(encoding)), encoding)
  371. *(*blockDescriptor)(d.descriptor) = blockDescriptor{Size: unsafe.Sizeof(objcBlock{}), Signature: signature}
  372. return nil
  373. }
  374. // Capture uses WKWebView's public snapshot API without exposing the window.
  375. func (d *Darwin) Capture(id uint64, full bool, done func([]byte, error)) {
  376. if full {
  377. done(nil, api.Err("BROWSER_CAPABILITY_UNSUPPORTED", "WKWebView full-page capture is not implemented"))
  378. return
  379. }
  380. p := d.pages[id]
  381. if p == nil {
  382. done(nil, api.Err("BROWSER_PAGE_NOT_FOUND", "WKWebView page is closed"))
  383. return
  384. }
  385. config := send(class("WKSnapshotConfiguration"), "new")
  386. defer release(config)
  387. send(config, "setAfterScreenUpdates:", true)
  388. block, err := d.completion(p, func(image, exception objc.ID) {
  389. if d.pages[id] != p {
  390. done(nil, api.Err("BROWSER_CLOSED", "page closed during capture"))
  391. return
  392. }
  393. if exception != 0 {
  394. done(nil, d.nativeError(exception, "BROWSER_CAPTURE_FAILED"))
  395. return
  396. }
  397. if image == 0 {
  398. done(nil, api.Err("BROWSER_CAPTURE_FAILED", "WKWebView returned no image"))
  399. return
  400. }
  401. tiff := send(image, "TIFFRepresentation")
  402. bitmap := send(class("NSBitmapImageRep"), "imageRepWithData:", tiff)
  403. if bitmap == 0 {
  404. done(nil, api.Err("BROWSER_CAPTURE_FAILED", "cannot encode snapshot"))
  405. return
  406. }
  407. width := objc.Send[int64](bitmap, selector("pixelsWide"))
  408. height := objc.Send[int64](bitmap, selector("pixelsHigh"))
  409. if width < 1 || height < 1 || width > capture.MaxDimension || height > capture.MaxDimension {
  410. done(nil, api.Err("BROWSER_RESULT_LIMIT", "capture dimensions exceed 4096 x 4096"))
  411. return
  412. }
  413. data := send(bitmap, "representationUsingType:properties:", uint64(4), send(class("NSDictionary"), "dictionary"))
  414. n := objc.Send[uint64](data, selector("length"))
  415. if n == 0 || n > capture.MaxBytes {
  416. done(nil, api.Err("BROWSER_RESULT_LIMIT", "capture exceeds 4 MiB or is empty"))
  417. return
  418. }
  419. ptr := objc.Send[*byte](data, selector("bytes"))
  420. if ptr == nil {
  421. done(nil, api.Err("BROWSER_CAPTURE_FAILED", "empty PNG buffer"))
  422. return
  423. }
  424. png := append([]byte(nil), unsafe.Slice(ptr, int(n))...)
  425. done(png, capture.Validate(png))
  426. })
  427. if err != nil {
  428. done(nil, err)
  429. return
  430. }
  431. send(p.view, "takeSnapshotWithConfiguration:completionHandler:", config, block)
  432. d.releaseBlock(block)
  433. }