Patched #124

Author: L'In20Cible

addons/source-python/packages/source-python/effects/base.py

@@ -45,14 +45,6 @@
 from _effects._base import BaseTempEntity
 
 
-# =============================================================================
-# >> GLOBAL VARIABLES
-# =============================================================================
-# Use a global RecipientFilter to prevent memory leaking...
-# See also: https://github.com/Source-Python-Dev-Team/Source.Python/issues/124
-_recipient_filter = RecipientFilter()
-
-
 # =============================================================================
 # >> ALL DECLARATION
 # =============================================================================
@@ -568,8 +560,8 @@ def create(self, *recipients, delay=0.0, **aliases):
         :param dict aliases: Any aliases to set before creating the temp entity
             effect.
         """
-        # Update the global recipient filter...
-        _recipient_filter.update(*recipients)
+        # Get a recipient filter matching the given players...
+        recipients = RecipientFilter(*recipients)
 
         # Loop trhough all given aliases...
         for alias, value in aliases.items():
@@ -578,7 +570,7 @@ def create(self, *recipients, delay=0.0, **aliases):
             setattr(self, alias, value)
 
         # Create the temp entity effect...
-        super().create(_recipient_filter, delay)
+        super().create(recipients, delay)
 
     @property
     def template(self):

addons/source-python/packages/source-python/messages/base.py

@@ -31,14 +31,6 @@
 from _messages import FadeFlags
 
 
-# =============================================================================
-# >> GLOBAL VARIABLES
-# =============================================================================
-# Use a global RecipientFilter to prevent memory leaking...
-# See also: https://github.com/Source-Python-Dev-Team/Source.Python/issues/124
-_recipient_filter = RecipientFilter()
-
-
 # =============================================================================
 # >> CLASSES
 # =============================================================================
@@ -73,9 +65,9 @@ def __setattr__(self, attr, value):
 
     def send(self, *player_indexes, **tokens):
         """Send the user message."""
-        _recipient_filter.update(*player_indexes)
+        player_indexes = RecipientFilter(*player_indexes)
         for language, indexes in self._categorize_players_by_language(
-                _recipient_filter).items():
+                player_indexes).items():
             translated_kwargs = AttrDict(self)
             translated_kwargs.update(
                 self._get_translated_kwargs(language, tokens))
@@ -88,9 +80,8 @@ def _send(self, player_indexes, translated_kwargs):
             setting.
         :param AttrDict translated_kwargs: The translated arguments.
         """
-        _recipient_filter.update(*player_indexes)
-        user_message = UserMessage(
-            _recipient_filter, self.message_name)
+        recipients = RecipientFilter(*player_indexes)
+        user_message = UserMessage(recipients, self.message_name)
 
         if user_message.is_protobuf():
             self.protobuf(user_message.buffer, translated_kwargs)
@@ -211,9 +202,8 @@ def send(self, *player_indexes):
         # differently, because the maximum size is 255. If the message exceeds
         # this length, we need to sent it in several parts.
         if UserMessage.is_protobuf():
-            _recipient_filter.update(*player_indexes)
-            user_message = UserMessage(
-                _recipient_filter, self.message_name)
+            recipients = RecipientFilter(*player_indexes)
+            user_message = UserMessage(recipients, self.message_name)
             self.protobuf(user_message.buffer, self)
             user_message.send()
         else:
@@ -229,10 +219,9 @@ def bitbuf(self, player_indexes, kwargs):
         """Send the ShowMenu with bitbuf."""
         menu_string = kwargs.menu_string
         length = len(menu_string)
-        _recipient_filter.update(*player_indexes)
+        recipients = RecipientFilter(*player_indexes)
         while True:
-            user_message = UserMessage(
-                _recipient_filter, self.message_name)
+            user_message = UserMessage(recipients, self.message_name)
 
             buffer = user_message.buffer
             buffer.write_word(kwargs.valid_slots)

src/core/modules/filters/filters_recipients.h

@@ -36,6 +36,40 @@
 #include "irecipientfilter.h"
 #include "bitvec.h"
 #include "tier1/utlvector.h"
+#include "modules/memory/memory_alloc.h"
+
+
+//---------------------------------------------------------------------------------
+// Patch for issue #124.
+//---------------------------------------------------------------------------------
+template<class T, class U = int>
+class CRecipientFilterAllocator : public CUtlMemory<T, U>
+{
+public:
+	CRecipientFilterAllocator(int nGrowSize = 0, int nInitSize = 0)
+	{
+		::CUtlMemory<T, U>(nGrowSize, nInitSize);
+	}
+
+	~CRecipientFilterAllocator() { m_nAllocationCount = 0; }
+
+	void *DetachAndReturn()
+	{
+		void *pMemory = m_pMemory;
+		m_pMemory = NULL;
+		return pMemory;
+	}
+};
+
+template<class T, class U = CRecipientFilterAllocator<T>>
+class CVecRecipients : public CUtlVector<T, U>
+{
+public:
+	~CVecRecipients()
+	{
+		UTIL_Dealloc(m_Memory.DetachAndReturn());
+	}
+};
 
 
 //---------------------------------------------------------------------------------
@@ -61,7 +95,7 @@ class MRecipientFilter : public IRecipientFilter
 private:
 	bool				m_bReliable;
 	bool				m_bInitMessage;
-	CUtlVector< int >	m_Recipients;
+	CVecRecipients<int>	m_Recipients;
 
 	// If using prediction rules, the filter itself suppresses local player
 	bool				m_bUsingPredictionRules;

src/core/modules/filters/filters_recipients_wrap.cpp

@@ -81,7 +81,7 @@ void export_mrecipientfilter(scope _recipients)
 		ADD_MEM_TOOLS(IRecipientFilter)
 	;
 
-	class_<MRecipientFilter, MRecipientFilter*, bases<IRecipientFilter>, boost::noncopyable >("_RecipientFilter")
+	class_<MRecipientFilter, boost::shared_ptr<MRecipientFilter>, bases<IRecipientFilter>, boost::noncopyable >("_RecipientFilter")
 		.def("add_all_players",
 			&MRecipientFilter::AddAllPlayers,
 			"Adds all the players on the server to the filter"