1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
|
//========= Copyright Valve Corporation, All rights reserved. ============//
//
// Purpose: Creates a HTML control
//
// $NoKeywords: $
//=============================================================================//
#include "winlite.h"
#include "html_chrome.h"
#include "tier1/interface.h"
#include "reliabletimer.h"
#include "htmlmanager.h"
#include "html/htmlprotobuf.h"
#include <html/ichromehtmlwrapper.h>
//-----------------------------------------------------------------------------
// Purpose: owner object that gets responses from the CEF thread and dispatches them
//-----------------------------------------------------------------------------
class CHTMLController : public IHTMLChromeController
{
public:
CHTMLController() { m_BrowserSerial = 0; m_nCefTargetFrameRate = 0; SetDefLessFunc( m_mapBrowserRequests ); SetDefLessFunc( m_mapBrowsers ); }
~CHTMLController() {}
bool Init( const char *pchHTMLCacheDir, const char *pchCookiePath );
void Shutdown();
void SetWebCookie( const char *pchHostname, const char *pchKey, const char *pchValue, const char *pchPath, RTime32 nExpires );
void GetWebCookiesForURL( CUtlString *pstrValue, const char *pchURL, const char *pchName );
void SetClientBuildID( uint64 ulBuildID );
bool BHasPendingMessages();
void CreateBrowser( IHTMLResponses *pBrowser, bool bPopupWindow, const char *pchUserAgentIdentifier );
void RemoveBrowser( IHTMLResponses *pBrowser );
bool RunFrame();
void WakeThread() { AccessHTMLWrapper().WakeThread(); }
HTMLCommandBuffer_t *GetFreeCommandBuffer( EHTMLCommands eCmd, int iBrowser ) { return AccessHTMLWrapper().GetFreeCommandBuffer( eCmd, iBrowser ); }
void PushCommand( HTMLCommandBuffer_t *pCmd ) { AccessHTMLWrapper().PushCommand( pCmd ); }
bool GetMainThreadCommand( HTMLCommandBuffer_t **pCmd ) { return AccessHTMLWrapper().GetMainThreadCommand( pCmd ); }
void ReleaseCommandBuffer( HTMLCommandBuffer_t *pCmd ) { AccessHTMLWrapper().ReleaseCommandBuffer( pCmd ); }
#ifdef DBGFLAG_VALIDATE
void Validate( CValidator &validator, const char *pchName );
bool ChromePrepareForValidate();
bool ChromeResumeFromValidate();
#endif
void SetCefThreadTargetFrameRate( uint32 nFPS );
private:
// keeps track of outstanding browser create requests
CUtlMap< uint32, IHTMLResponses *, int > m_mapBrowserRequests;
// the next unique identifier to use when doing a browser create
uint32 m_BrowserSerial;
// the map of browser handles to our html panel objects, used for cef thread command dispatching
CUtlMap< uint32, IHTMLResponses *, int > m_mapBrowsers;
int m_nCefTargetFrameRate;
};
static CHTMLController s_HTMLController;
EXPOSE_SINGLE_INTERFACE_GLOBALVAR( CHTMLController, IHTMLChromeController, CHROMEHTML_CONTROLLER_INTERFACE_VERSION, s_HTMLController );
//-----------------------------------------------------------------------------
// Purpose: request the cef thread to make a new browser
//-----------------------------------------------------------------------------
void CHTMLController::CreateBrowser( IHTMLResponses *pBrowser, bool bPopupWindow, const char *pchUserAgentIdentifier )
{
m_BrowserSerial++;
m_mapBrowserRequests.Insert( m_BrowserSerial, pBrowser );
CHTMLProtoBufMsg<CMsgBrowserCreate> cmd( eHTMLCommands_BrowserCreate );
cmd.Body().set_request_id( m_BrowserSerial );
cmd.Body().set_popup( bPopupWindow );
cmd.Body().set_useragent( pchUserAgentIdentifier );
HTMLCommandBuffer_t *pBuf = AccessHTMLWrapper().GetFreeCommandBuffer( eHTMLCommands_BrowserCreate, -1 );
cmd.SerializeCrossProc( &pBuf->m_Buffer );
AccessHTMLWrapper().PushCommand( pBuf );
}
//-----------------------------------------------------------------------------
// Purpose: delete a browser we have
//-----------------------------------------------------------------------------
void CHTMLController::RemoveBrowser( IHTMLResponses *pBrowser )
{
// pull ourselves from the browser handle list as we are doing away
FOR_EACH_MAP_FAST( m_mapBrowsers, i)
{
if ( m_mapBrowsers[i] == pBrowser )
{
// tell the cef thread this browser is going away
CHTMLProtoBufMsg<CMsgBrowserRemove> cmd( eHTMLCommands_BrowserRemove );
cmd.Body().set_browser_handle( pBrowser->BrowserGetIndex() );
HTMLCommandBuffer_t *pBuf = AccessHTMLWrapper().GetFreeCommandBuffer( eHTMLCommands_BrowserRemove, pBrowser->BrowserGetIndex() );
cmd.SerializeCrossProc( &pBuf->m_Buffer );
AccessHTMLWrapper().PushCommand( pBuf );
// now kill it
m_mapBrowsers.RemoveAt( i );
}
}
// also remove us from pending list if in it
FOR_EACH_MAP_FAST( m_mapBrowserRequests, i)
{
if ( m_mapBrowserRequests[i] == pBrowser )
m_mapBrowserRequests.RemoveAt( i );
}
}
//-----------------------------------------------------------------------------
// Purpose: turn on the cef engine
//-----------------------------------------------------------------------------
bool CHTMLController::Init( const char *pchHTMLCacheDir, const char *pchCookiePath )
{
#if !defined(WIN64) && !defined(STATIC_TIER0)
ChromeInit( pchHTMLCacheDir, pchCookiePath );
#endif
return true;
}
//-----------------------------------------------------------------------------
// Purpose: shutdown chrome
//-----------------------------------------------------------------------------
void CHTMLController::Shutdown()
{
#if !defined(WIN64) && !defined(STATIC_TIER0)
ChromeShutdown();
#endif
}
// helper macro to dispatch messages from the cef thread
#define HTML_MSG_FUNC( eHTMLCommand, bodyType, commandFunc ) \
case eHTMLCommand: \
{ \
CHTMLProtoBufMsg< bodyType > cmd( pCmd->m_eCmd ); \
if ( !cmd.BDeserializeCrossProc( &pCmd->m_Buffer ) ) \
{ \
bError = true; \
} \
else \
{ \
int idx = m_mapBrowsers.Find( cmd.BodyConst().browser_handle() ); \
if ( idx != m_mapBrowsers.InvalidIndex() ) \
{ \
if ( m_mapBrowsers[idx] ) \
m_mapBrowsers[idx]->commandFunc( &cmd.BodyConst() ); \
} \
} \
} \
break; \
//-----------------------------------------------------------------------------
// Purpose: process any ipc responses we have pending
//-----------------------------------------------------------------------------
bool CHTMLController::RunFrame()
{
VPROF_BUDGET( "CHTMLController::RunFrame", VPROF_BUDGETGROUP_TENFOOT );
HTMLCommandBuffer_t *pCmd;
bool bError = false;
bool bDidwork = false;
// Paint messages are dispatched last to avoid doing excessive work on
// the main thread when two paint messages have stacked up in the queue.
// This could be greatly optimized by doing atomic buffer swaps instead
// of pushing the paint updates through a queue, but this helps for now.
// -henryg
CUtlVector< HTMLCommandBuffer_t * > vecDeferredPaint;
while( GetMainThreadCommand( &pCmd ) )
{
bool bRelease = true;
bDidwork = true;
//Msg( "Got response %d\n", pCmd->m_eCmd );
switch( pCmd->m_eCmd )
{
default:
break;
case eHTMLCommands_BrowserCreateResponse:
{
CHTMLProtoBufMsg< CMsgBrowserCreateResponse > cmd( pCmd->m_eCmd );
if ( !cmd.BDeserializeCrossProc( &pCmd->m_Buffer ) )
{
bError = true;
}
else
{
int idx = m_mapBrowserRequests.Find( cmd.BodyConst().request_id() );
if ( idx != m_mapBrowserRequests.InvalidIndex() )
{
m_mapBrowsers.Insert( cmd.BodyConst().browser_handle(), m_mapBrowserRequests[idx] );
m_mapBrowserRequests[idx]->BrowserSetIndex( cmd.BodyConst().browser_handle() );
m_mapBrowserRequests.RemoveAt( idx );
}
}
}
break;
case eHTMLCommands_NeedsPaint:
{
bRelease = false;
vecDeferredPaint.AddToTail( pCmd );
}
break;
HTML_MSG_FUNC( eHTMLCommands_BrowserReady, CMsgBrowserReady, BrowserReady );
HTML_MSG_FUNC( eHTMLCommands_StartRequest, CMsgStartRequest, BrowserStartRequest );
HTML_MSG_FUNC( eHTMLCommands_URLChanged, CMsgURLChanged, BrowserURLChanged );
HTML_MSG_FUNC( eHTMLCommands_FinishedRequest, CMsgFinishedRequest, BrowserFinishedRequest );
HTML_MSG_FUNC( eHTMLCommands_ShowPopup, CMsgShowPopup, BrowserShowPopup );
HTML_MSG_FUNC( eHTMLCommands_HidePopup, CMsgHidePopup, BrowserHidePopup );
HTML_MSG_FUNC( eHTMLCommands_OpenNewTab, CMsgOpenNewTab, BrowserOpenNewTab );
HTML_MSG_FUNC( eHTMLCommands_PopupHTMLWindow, CMsgPopupHTMLWindow, BrowserPopupHTMLWindow );
HTML_MSG_FUNC( eHTMLCommands_SetHTMLTitle, CMsgSetHTMLTitle, BrowserSetHTMLTitle );
HTML_MSG_FUNC( eHTMLCommands_LoadingResource, CMsgLoadingResource, BrowserLoadingResource );
HTML_MSG_FUNC( eHTMLCommands_StatusText, CMsgStatusText, BrowserStatusText );
HTML_MSG_FUNC( eHTMLCommands_SetCursor, CMsgSetCursor, BrowserSetCursor );
HTML_MSG_FUNC( eHTMLCommands_FileLoadDialog, CMsgFileLoadDialog, BrowserFileLoadDialog );
HTML_MSG_FUNC( eHTMLCommands_ShowToolTip, CMsgShowToolTip, BrowserShowToolTip );
HTML_MSG_FUNC( eHTMLCommands_UpdateToolTip, CMsgUpdateToolTip, BrowserUpdateToolTip );
HTML_MSG_FUNC( eHTMLCommands_HideToolTip, CMsgHideToolTip, BrowserHideToolTip );
HTML_MSG_FUNC( eHTMLCommands_SearchResults, CMsgSearchResults, BrowserSearchResults );
HTML_MSG_FUNC( eHTMLCommands_Close, CMsgClose, BrowserClose );
HTML_MSG_FUNC( eHTMLCommands_GetZoomResponse, CMsgGetZoomResponse, BrowserGetZoomResponse );
HTML_MSG_FUNC( eHTMLCommands_HorizontalScrollBarSizeResponse, CMsgHorizontalScrollBarSizeResponse, BrowserHorizontalScrollBarSizeResponse );
HTML_MSG_FUNC( eHTMLCommands_VerticalScrollBarSizeResponse, CMsgVerticalScrollBarSizeResponse, BrowserVerticalScrollBarSizeResponse );
HTML_MSG_FUNC( eHTMLCommands_LinkAtPositionResponse, CMsgLinkAtPositionResponse, BrowserLinkAtPositionResponse );
HTML_MSG_FUNC( eHTMLCommands_ZoomToElementAtPositionResponse, CMsgZoomToElementAtPositionResponse, BrowserZoomToElementAtPositionResponse );
HTML_MSG_FUNC( eHTMLCommands_JSAlert, CMsgJSAlert, BrowserJSAlert );
HTML_MSG_FUNC( eHTMLCommands_JSConfirm, CMsgJSConfirm, BrowserJSConfirm );
HTML_MSG_FUNC( eHTMLCommands_OpenSteamURL, CMsgOpenSteamURL, BrowserOpenSteamURL );
HTML_MSG_FUNC( eHTMLCommands_CanGoBackandForward, CMsgCanGoBackAndForward, BrowserCanGoBackandForward );
HTML_MSG_FUNC( eHTMLCommands_SizePopup, CMsgSizePopup, BrowserSizePopup );
HTML_MSG_FUNC( eHTMLCommands_ScaleToValueResponse, CMsgScalePageToValueResponse, BrowserScalePageToValueResponse );
HTML_MSG_FUNC( eHTMLCommands_RequestFullScreen, CMsgRequestFullScreen, BrowserRequestFullScreen );
HTML_MSG_FUNC( eHTMLCommands_ExitFullScreen, CMsgExitFullScreen, BrowserExitFullScreen );
HTML_MSG_FUNC( eHTMLCommands_GetCookiesForURLResponse, CMsgGetCookiesForURLResponse, BrowserGetCookiesForURLResponse );
HTML_MSG_FUNC( eHTMLCommands_NodeGotFocus, CMsgNodeHasFocus, BrowserNodeGotFocus );
HTML_MSG_FUNC( eHTMLCommands_SavePageToJPEGResponse, CMsgSavePageToJPEGResponse, BrowserSavePageToJPEGResponse );
HTML_MSG_FUNC( eHTMLCommands_GetFocusedNodeValueResponse, CMsgFocusedNodeTextResponse, BrowserFocusedNodeValueResponse );
}
if ( bError )
{
Warning( "Failed to parse command %d", pCmd->m_eCmd );
Assert( !"Bad Command" );
}
if ( bRelease )
{
ReleaseCommandBuffer( pCmd );
}
}
// Collapse deferred paints by browser ID and process them; the latest texture always
// has fully updated bits, we simply union its dirty rect with the skipped updates.
// Note: browser resizes always include a full dirty rect, we don't have to check here.
while ( vecDeferredPaint.Count() )
{
// Pull the last paint off the queue
pCmd = vecDeferredPaint[ vecDeferredPaint.Count() - 1 ];
int iBrowser = pCmd->m_iBrowser;
CHTMLProtoBufMsg<CMsgNeedsPaint> cmd( eHTMLCommands_NeedsPaint );
DbgVerify( cmd.BDeserializeCrossProc( &pCmd->m_Buffer ) );
ReleaseCommandBuffer( pCmd );
vecDeferredPaint.Remove( vecDeferredPaint.Count() - 1 );
CMsgNeedsPaint &body = cmd.Body();
CChromeUpdateRegion region;
if ( body.updatewide() && body.updatetall() )
{
region.MarkDirtyRect( body.updatex(), body.updatey(), body.updatex() + body.updatewide(), body.updatey() + body.updatetall() );
}
else
{
region.MarkAllDirty();
}
// Remove earlier paints for the same browser from the queue
for ( int i = vecDeferredPaint.Count() - 1; i >= 0; --i )
{
if ( vecDeferredPaint[i]->m_iBrowser == iBrowser )
{
// Decode
CHTMLProtoBufMsg<CMsgNeedsPaint> cmdMerge( eHTMLCommands_NeedsPaint );
DbgVerify( cmdMerge.BDeserializeCrossProc( &vecDeferredPaint[i]->m_Buffer ) );
CMsgNeedsPaint &bodyMerge = cmdMerge.Body();
if ( body.browser_handle() == bodyMerge.browser_handle() )
{
ReleaseCommandBuffer( vecDeferredPaint[i] );
vecDeferredPaint.Remove( i );
// Merge update region
if ( bodyMerge.updatewide() && bodyMerge.updatetall() )
{
region.MarkDirtyRect( bodyMerge.updatex(), bodyMerge.updatey(), bodyMerge.updatex() + bodyMerge.updatewide(), bodyMerge.updatey() + bodyMerge.updatetall() );
}
else
{
region.MarkAllDirty();
}
// Send response to the skipped paint update to free up the texture slot
pCmd = GetFreeCommandBuffer( eHTMLCommands_NeedsPaintResponse, bodyMerge.browser_handle() );
CHTMLProtoBufMsg<CMsgNeedsPaintResponse> cmdResponse( eHTMLCommands_NeedsPaintResponse );
cmdResponse.Body().set_browser_handle( bodyMerge.browser_handle() );
cmdResponse.Body().set_textureid( bodyMerge.textureid() );
cmdResponse.SerializeCrossProc( &pCmd->m_Buffer );
PushCommand( pCmd );
}
}
}
// Dispatch the merged update
int idxBrowser = m_mapBrowsers.Find( body.browser_handle() );
if ( idxBrowser != m_mapBrowsers.InvalidIndex() )
{
if ( m_mapBrowsers[idxBrowser] )
{
int updateWide = region.GetUpdateWide( body.wide() );
int updateTall = region.GetUpdateTall( body.tall() );
if ( updateWide != body.wide() || updateTall != body.tall() )
{
body.set_updatex( region.GetUpdateX( body.wide() ) );
body.set_updatey( region.GetUpdateY( body.tall() ) );
body.set_updatewide( updateWide );
body.set_updatetall( updateTall );
}
else
{
body.clear_updatex();
body.clear_updatey();
body.clear_updatewide();
body.clear_updatetall();
}
m_mapBrowsers[idxBrowser]->BrowserNeedsPaint( &body );
}
}
}
return bDidwork;
}
//-----------------------------------------------------------------------------
// Purpose: set a cef cookie
//-----------------------------------------------------------------------------
void CHTMLController::SetWebCookie( const char *pchHostname, const char *pchKey, const char *pchValue, const char *pchPath, RTime32 nExpires )
{
#if !defined(WIN64) && !defined(STATIC_TIER0)
ChromeSetWebCookie( pchHostname, pchKey, pchValue, pchPath, nExpires );
#endif
}
//-----------------------------------------------------------------------------
// Purpose: set the buildid to report
//-----------------------------------------------------------------------------
void CHTMLController::SetClientBuildID( uint64 ulBuildID )
{
#if !defined(WIN64) && !defined(STATIC_TIER0)
ChromeSetClientBuildID( ulBuildID );
#endif
}
//-----------------------------------------------------------------------------
// Purpose: get the cef cookies for a url
//-----------------------------------------------------------------------------
void CHTMLController::GetWebCookiesForURL( CUtlString *pstrValue, const char *pchURL, const char *pchName )
{
#if !defined(WIN64) && !defined(STATIC_TIER0)
ChromeGetWebCookiesForURL( pstrValue, pchURL, pchName );
#endif
}
//-----------------------------------------------------------------------------
// Purpose: true if any pending html message in the queue
//-----------------------------------------------------------------------------
bool CHTMLController::BHasPendingMessages()
{
return AccessHTMLWrapper().BHasPendingMessages();
}
//-----------------------------------------------------------------------------
// Purpose: tell the cef thread the frame rate to use if it changes
//-----------------------------------------------------------------------------
void CHTMLController::SetCefThreadTargetFrameRate( uint32 nFPS )
{
if ( nFPS != m_nCefTargetFrameRate )
{
m_nCefTargetFrameRate = nFPS;
CHTMLProtoBufMsg<CMsgSetTargetFrameRate> cmd( eHTMLCommands_SetTargetFrameRate );
cmd.Body().set_ntargetframerate( nFPS );
HTMLCommandBuffer_t *pBuf = AccessHTMLWrapper().GetFreeCommandBuffer( eHTMLCommands_SetTargetFrameRate, -1 );
cmd.SerializeCrossProc( &pBuf->m_Buffer );
AccessHTMLWrapper().PushCommand( pBuf );
}
}
#ifdef DBGFLAG_VALIDATE
//-----------------------------------------------------------------------------
// Purpose: validate mem
//-----------------------------------------------------------------------------
void CHTMLController::Validate( CValidator &validator, const char *pchName )
{
ChromeValidate( validator, "ChromeValidate" );
validator.Push( "CHTMLController::ValidateStatics", NULL, pchName );
ValidateObj( m_mapBrowserRequests );
ValidateObj( m_mapBrowsers );
validator.Pop();
}
bool CHTMLController::ChromeResumeFromValidate()
{
return ::ChromeResumeFromValidate();
}
bool CHTMLController::ChromePrepareForValidate()
{
return ::ChromePrepareForValidate();
}
#endif // DBGFLAG_VALIDATE
|