Skip to content

Commit 046a3d4

Browse files
jordanbrierejordanbriere
committed
Fixed #400 and #404.
Added lazy-loading support to the internal logging listener. Fixed ListenerManager.clear not being properly finalized. Fixed an infinite recursion when a server output callback is raising.
1 parent 4c48e52 commit 046a3d4

File tree

5 files changed

+172
-121
lines changed

5 files changed

+172
-121
lines changed

‎src/core/modules/listeners/listeners_manager.cpp‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,15 @@
2828
// Includes.
2929
//-----------------------------------------------------------------------------
3030
#include "listeners_manager.h"
31+
#include "sp_main.h"
32+
#include "utilities/sp_util.h"
3133

3234

3335
//-----------------------------------------------------------------------------
3436
// External variables.
3537
//-----------------------------------------------------------------------------
3638
extern ICvar* g_pCVar;
39+
extern CServerOutputListenerManager* GetOnServerOutputListenerManager();
3740

3841

3942
//-----------------------------------------------------------------------------
@@ -196,6 +199,128 @@ void CConVarChangedListenerManager::Finalize()
196199
}
197200

198201

202+
//-----------------------------------------------------------------------------
203+
// Server output hook.
204+
//-----------------------------------------------------------------------------
205+
#if defined(ENGINE_ORANGEBOX) || defined(ENGINE_BMS) || defined(ENGINE_GMOD)
206+
SpewRetval_t SP_SpewOutput( SpewType_t spewType, const tchar *pMsg )
207+
{
208+
static CServerOutputListenerManager *pManager = GetOnServerOutputListenerManager();
209+
210+
if (!pManager->CallCallbacks((MessageSeverity)spewType, pMsg) && pManager->m_pOldSpewOutputFunc) {
211+
return pManager->m_pOldSpewOutputFunc(spewType, pMsg);
212+
}
213+
214+
return SPEW_CONTINUE;
215+
}
216+
#else
217+
class SPLoggingListener: public ILoggingListener
218+
{
219+
public:
220+
virtual void Log( const LoggingContext_t *pContext, const tchar *pMessage )
221+
{
222+
static CServerOutputListenerManager *pManager = GetOnServerOutputListenerManager();
223+
224+
if (!pManager->CallCallbacks((MessageSeverity)pContext->m_Severity, pMessage))
225+
{
226+
// Restore the old logging state before SP has been loaded
227+
LoggingSystem_PopLoggingState(false);
228+
229+
// Resend the log message. Our listener won't get called anymore
230+
LoggingSystem_LogDirect(
231+
pContext->m_ChannelID,
232+
pContext->m_Severity,
233+
pContext->m_Color,
234+
pMessage);
235+
236+
// Create a new logging state with only our listener being active
237+
#if defined(ENGINE_LEFT4DEAD2)
238+
LoggingSystem_PushLoggingState(false);
239+
#else
240+
LoggingSystem_PushLoggingState(false, true);
241+
#endif
242+
LoggingSystem_RegisterLoggingListener(this);
243+
244+
}
245+
}
246+
} g_LoggingListener;
247+
248+
#endif
249+
250+
251+
//-----------------------------------------------------------------------------
252+
// CServerOutputListenerManager constructor.
253+
//-----------------------------------------------------------------------------
254+
CServerOutputListenerManager::CServerOutputListenerManager()
255+
#if defined(ENGINE_ORANGEBOX) || defined(ENGINE_BMS) || defined(ENGINE_GMOD)
256+
:m_pOldSpewOutputFunc(NULL)
257+
#endif
258+
{
259+
}
260+
261+
262+
//-----------------------------------------------------------------------------
263+
// Called when the first callback is being registered.
264+
//-----------------------------------------------------------------------------
265+
void CServerOutputListenerManager::Initialize()
266+
{
267+
#if defined(ENGINE_ORANGEBOX) || defined(ENGINE_BMS) || defined(ENGINE_GMOD)
268+
DevMsg(1, MSG_PREFIX "Retrieving old output function...\n");
269+
m_pOldSpewOutputFunc = GetSpewOutputFunc();
270+
271+
DevMsg(1, MSG_PREFIX "Setting new output function...\n");
272+
SpewOutputFunc(SP_SpewOutput);
273+
#else
274+
DevMsg(1, MSG_PREFIX "Registering logging listener...\n");
275+
#if defined(ENGINE_LEFT4DEAD2)
276+
LoggingSystem_PushLoggingState(false);
277+
#else
278+
LoggingSystem_PushLoggingState(false, true);
279+
#endif
280+
LoggingSystem_RegisterLoggingListener(&g_LoggingListener);
281+
#endif
282+
}
283+
284+
285+
//-----------------------------------------------------------------------------
286+
// Called when the last callback is being unregistered.
287+
//-----------------------------------------------------------------------------
288+
void CServerOutputListenerManager::Finalize()
289+
{
290+
#if defined(ENGINE_ORANGEBOX) || defined(ENGINE_BMS) || defined(ENGINE_GMOD)
291+
if (m_pOldSpewOutputFunc) {
292+
DevMsg(1, MSG_PREFIX "Restoring old output function...\n");
293+
SpewOutputFunc(m_pOldSpewOutputFunc);
294+
}
295+
#else
296+
DevMsg(1, MSG_PREFIX "Restoring old logging state...\n");
297+
LoggingSystem_PopLoggingState(false);
298+
#endif
299+
}
300+
301+
302+
//-----------------------------------------------------------------------------
303+
// Calls all registered server output callbacks.
304+
//-----------------------------------------------------------------------------
305+
bool CServerOutputListenerManager::CallCallbacks(MessageSeverity severity, const tchar *pMsg)
306+
{
307+
bool block = false;
308+
m_Mutex.Lock(); {
309+
FOR_EACH_VEC(m_vecCallables, i) {
310+
try {
311+
object return_value = m_vecCallables[i](severity, pMsg);
312+
313+
if (!return_value.is_none() && extract<OutputReturn>(return_value) == OUTPUT_BLOCK)
314+
block = true;
315+
} catch (...) {
316+
PrintCurrentException(false);
317+
}
318+
}
319+
} m_Mutex.Unlock();
320+
return block;
321+
}
322+
323+
199324
//-----------------------------------------------------------------------------
200325
// Functions
201326
//-----------------------------------------------------------------------------

‎src/core/modules/listeners/listeners_manager.h‎

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,16 @@
3030
//-----------------------------------------------------------------------------
3131
// Includes.
3232
//-----------------------------------------------------------------------------
33+
// Source.Python
3334
#include "utilities/wrap_macros.h"
34-
#include "utlvector.h"
35+
#include "utilities/baseentity.h"
36+
#include "modules/core/core.h"
3537

38+
// SDK
39+
#include "utlvector.h"
3640
#include "convar.h"
41+
#include "dbg.h"
42+
#include "tier0/threadtools.h"
3743

3844

3945
//-----------------------------------------------------------------------------
@@ -112,6 +118,28 @@ class CConVarChangedListenerManager: public CListenerManager
112118
};
113119

114120

121+
//-----------------------------------------------------------------------------
122+
// CServerOutputListenerManager class.
123+
//-----------------------------------------------------------------------------
124+
class CServerOutputListenerManager: public CListenerManager
125+
{
126+
public:
127+
CServerOutputListenerManager();
128+
129+
virtual void Initialize();
130+
virtual void Finalize();
131+
132+
bool CallCallbacks(MessageSeverity severity, const tchar *pMsg);
133+
134+
public:
135+
CThreadMutex m_Mutex;
136+
137+
#if defined(ENGINE_ORANGEBOX) || defined(ENGINE_BMS) || defined(ENGINE_GMOD)
138+
SpewOutputFunc_t m_pOldSpewOutputFunc;
139+
#endif
140+
};
141+
142+
115143
//-----------------------------------------------------------------------------
116144
// Functions
117145
//-----------------------------------------------------------------------------

‎src/core/modules/listeners/listeners_wrap.cpp‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@ DEFINE_MANAGER_ACCESSOR(OnNetworkedEntityDeleted)
6161
DEFINE_MANAGER_ACCESSOR(OnDataLoaded)
6262
DEFINE_MANAGER_ACCESSOR(OnCombinerPreCache)
6363
DEFINE_MANAGER_ACCESSOR(OnDataUnloaded)
64-
DEFINE_MANAGER_ACCESSOR(OnServerOutput)
6564
DEFINE_MANAGER_ACCESSOR(OnPlayerRunCommand)
6665
DEFINE_MANAGER_ACCESSOR(OnButtonStateChanged)
6766

@@ -71,6 +70,12 @@ CConVarChangedListenerManager* GetOnConVarChangedListenerManager()
7170
return &s_OnConVarChanged;
7271
}
7372

73+
static CServerOutputListenerManager s_OnServerOutput;
74+
CServerOutputListenerManager *GetOnServerOutputListenerManager()
75+
{
76+
return &s_OnServerOutput;
77+
}
78+
7479

7580
//-----------------------------------------------------------------------------
7681
// Forward declarations.
@@ -177,7 +182,7 @@ void export_listener_managers(scope _listeners)
177182
_listeners.attr("on_combiner_pre_cache_listener_manager") = object(ptr(GetOnCombinerPreCacheListenerManager()));
178183
_listeners.attr("on_data_unloaded_listener_manager") = object(ptr(GetOnDataUnloadedListenerManager()));
179184

180-
_listeners.attr("on_server_output_listener_manager") = object(ptr(GetOnServerOutputListenerManager()));
185+
_listeners.attr("on_server_output_listener_manager") = object(ptr((CListenerManager *)GetOnServerOutputListenerManager()));
181186

182187
_listeners.attr("on_player_run_command_listener_manager") = object(ptr(GetOnPlayerRunCommandListenerManager()));
183188
_listeners.attr("on_button_state_changed_listener_manager") = object(ptr(GetOnButtonStateChangedListenerManager()));

‎src/core/sp_main.cpp‎

Lines changed: 4 additions & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ extern void InitCommands();
113113
extern void ClearAllCommands();
114114
extern PLUGIN_RESULT DispatchClientCommand(edict_t *pEntity, const CCommand &command);
115115
extern CConVarChangedListenerManager* GetOnConVarChangedListenerManager();
116+
extern CServerOutputListenerManager* GetOnServerOutputListenerManager();
116117

117118
//-----------------------------------------------------------------------------
118119
// The plugin is a static singleton that is exported as an interface
@@ -188,100 +189,13 @@ bool GetInterfaces( InterfaceHelper_t* pInterfaceList, CreateInterfaceFn factory
188189
}
189190

190191

191-
//-----------------------------------------------------------------------------
192-
// Server output hook.
193-
//-----------------------------------------------------------------------------
194-
#if defined(ENGINE_ORANGEBOX) || defined(ENGINE_BMS) || defined(ENGINE_GMOD)
195-
SpewRetval_t SP_SpewOutput( SpewType_t spewType, const tchar *pMsg )
196-
{
197-
bool block = false;
198-
199-
// Only filter outputs from the main thread. See issues #400 and #404.
200-
if (ThreadInMainThread()) {
201-
extern CListenerManager* GetOnServerOutputListenerManager();
202-
203-
for(int i = 0; i < GetOnServerOutputListenerManager()->m_vecCallables.Count(); i++)
204-
{
205-
BEGIN_BOOST_PY()
206-
object return_value = GetOnServerOutputListenerManager()->m_vecCallables[i](
207-
(MessageSeverity) spewType,
208-
pMsg);
209-
210-
if (!return_value.is_none() && extract<OutputReturn>(return_value) == OUTPUT_BLOCK)
211-
block = true;
212-
213-
END_BOOST_PY_NORET()
214-
}
215-
}
216-
217-
if (!block && g_SourcePythonPlugin.m_pOldSpewOutputFunc)
218-
return g_SourcePythonPlugin.m_pOldSpewOutputFunc(spewType, pMsg);
219-
220-
return SPEW_CONTINUE;
221-
}
222-
#else
223-
class SPLoggingListener: public ILoggingListener
224-
{
225-
public:
226-
virtual void Log( const LoggingContext_t *pContext, const tchar *pMessage )
227-
{
228-
bool block = false;
229-
230-
// Only filter outputs from the main thread. See issues #400 and #404.
231-
if (ThreadInMainThread()) {
232-
extern CListenerManager* GetOnServerOutputListenerManager();
233-
234-
for(int i = 0; i < GetOnServerOutputListenerManager()->m_vecCallables.Count(); i++)
235-
{
236-
BEGIN_BOOST_PY()
237-
object return_value = GetOnServerOutputListenerManager()->m_vecCallables[i](
238-
(MessageSeverity) pContext->m_Severity,
239-
pMessage);
240-
241-
if (!return_value.is_none() && extract<OutputReturn>(return_value) == OUTPUT_BLOCK)
242-
block = true;
243-
244-
END_BOOST_PY_NORET()
245-
}
246-
}
247-
248-
if (!block)
249-
{
250-
// Restore the old logging state before SP has been loaded
251-
LoggingSystem_PopLoggingState(false);
252-
253-
// Resend the log message. Our listener won't get called anymore
254-
LoggingSystem_LogDirect(
255-
pContext->m_ChannelID,
256-
pContext->m_Severity,
257-
pContext->m_Color,
258-
pMessage);
259-
260-
// Create a new logging state with only our listener being active
261-
#if defined(ENGINE_LEFT4DEAD2)
262-
LoggingSystem_PushLoggingState(false);
263-
#else
264-
LoggingSystem_PushLoggingState(false, true);
265-
#endif
266-
LoggingSystem_RegisterLoggingListener(this);
267-
268-
}
269-
}
270-
} g_LoggingListener;
271-
272-
#endif
273-
274192
//-----------------------------------------------------------------------------
275193
// Purpose: constructor/destructor
276194
//-----------------------------------------------------------------------------
277195
CSourcePython::CSourcePython()
278196
{
279197
m_iClientCommandIndex = 0;
280198
m_pOldMDLCacheNotifier = NULL;
281-
282-
#if defined(ENGINE_ORANGEBOX) || defined(ENGINE_BMS) || defined(ENGINE_GMOD)
283-
m_pOldSpewOutputFunc = NULL;
284-
#endif
285199
}
286200

287201
CSourcePython::~CSourcePython()
@@ -336,22 +250,6 @@ bool CSourcePython::Load( CreateInterfaceFn interfaceFactory, CreateInterfaceFn
336250
return false;
337251
}
338252

339-
#if defined(ENGINE_ORANGEBOX) || defined(ENGINE_BMS) || defined(ENGINE_GMOD)
340-
DevMsg(1, MSG_PREFIX "Retrieving old output function...\n");
341-
m_pOldSpewOutputFunc = GetSpewOutputFunc();
342-
343-
DevMsg(1, MSG_PREFIX "Setting new output function...\n");
344-
SpewOutputFunc(SP_SpewOutput);
345-
#else
346-
DevMsg(1, MSG_PREFIX "Registering logging listener...\n");
347-
#if defined(ENGINE_LEFT4DEAD2)
348-
LoggingSystem_PushLoggingState(false);
349-
#else
350-
LoggingSystem_PushLoggingState(false, true);
351-
#endif
352-
LoggingSystem_RegisterLoggingListener(&g_LoggingListener);
353-
#endif
354-
355253
// TODO: Don't hardcode the 64 bytes offset
356254
#ifdef ENGINE_LEFT4DEAD2
357255
#define CACHE_NOTIFY_OFFSET 68
@@ -383,17 +281,6 @@ void CSourcePython::Unload( void )
383281
{
384282
Msg(MSG_PREFIX "Unloading...\n");
385283

386-
#if defined(ENGINE_ORANGEBOX) || defined(ENGINE_BMS) || defined(ENGINE_GMOD)
387-
if (m_pOldSpewOutputFunc)
388-
{
389-
DevMsg(1, MSG_PREFIX "Restoring old output function...\n");
390-
SpewOutputFunc(m_pOldSpewOutputFunc);
391-
}
392-
#else
393-
DevMsg(1, MSG_PREFIX "Restoring old logging state...\n");
394-
LoggingSystem_PopLoggingState(false);
395-
#endif
396-
397284
DevMsg(1, MSG_PREFIX "Resetting cache notifier...\n");
398285
modelcache->SetCacheNotify(m_pOldMDLCacheNotifier);
399286

@@ -403,6 +290,9 @@ void CSourcePython::Unload( void )
403290
DevMsg(1, MSG_PREFIX "Clearing convar changed listener...\n");
404291
GetOnConVarChangedListenerManager()->clear();
405292

293+
DevMsg(1, MSG_PREFIX "Clearing server output listeners...\n");
294+
GetOnServerOutputListenerManager()->clear();
295+
406296
DevMsg(1, MSG_PREFIX "Unhooking all functions...\n");
407297
GetHookManager()->UnhookAllFunctions();
408298

0 commit comments

Comments
 (0)