Partial fix for issue #390.

[vinci6k]

This fixes the hooks from not getting called when the UserMessage was created/sent by a third-party plugin (SourceMod), but I'm not sure how to retrieve the actual UserMessage data (e.g. ShowMenu data).

[jordanbriere]

Nice one! What do you mean by retrieving the data?

[vinci6k]

Sorry for not being more clear. The following code should print the contents of a sent menu:

from messages.hooks import HookProtobufUserMessage


@HookProtobufUserMessage('ShowMenu')
def show_menu_pre(recipients, buffer):
    """Called when a ShowMenu user message gets sent."""
    print(buffer.get_string('menu_string'))

It does with SP menus, but not with SM menus.
I understand that by creating a new UserMessage, the buffer will be empty. So I'm looking for a way to somehow get that data, if such a thing is even possible?

[jordanbriere]

Sorry for not being more clear. The following code should print the contents of a sent menu:

from messages.hooks import HookProtobufUserMessage


@HookProtobufUserMessage('ShowMenu')
def show_menu_pre(recipients, buffer):
    """Called when a ShowMenu user message gets sent."""
    print(buffer.get_string('menu_string'))

It does with SP menus, but not with SM menus.
I understand that by creating a new UserMessage, the buffer will be empty. So I'm looking for a way to somehow get that data, if such a thing is even possible?

Ah yeah. There are two possible causes;

• Its size is dynamic and not enough data is copied because get_size returns the size of the interface, not the actual message.
• The calls aren't mapped properly because the dispatch table was overwritten. Not copying the first 4 bytes could work.

That said, the ideal solution would be to simply have a static constructor (for example, like RecipientFilter.from_abstract that create a new message and make a copy of the fields using Message::CopyFrom -- either that or export those directly though more efficient through a one-call constructor.

[vinci6k]

Yep, it's the size. As soon as I added a few bytes it started working properly:

buffer_size = get_size(buffer) + 16

Running this and opening the admin menu from SourceMod:

@HookProtobufUserMessage('ShowMenu')
def show_menu_pre(recipients, buffer):
    """Called when a ShowMenu user message gets sent."""
    print(buffer.get_int32('bits_valid_slots'))
    print(buffer.get_int32('display_time'))
    print(buffer.get_string('menu_string'))

Prints this:

263
0
Admin Menu:
->1. Player Commands
->2. Server Commands
->3. Voting Commands

->9. Exit

That said, the ideal solution would be to simply have a static constructor (for example, like RecipientFilter.from_abstract that create a new message and make a copy of the fields using Message::CopyFrom -- either that or export those directly though more efficient through a one-call constructor.

I'd love to do that, but I'm kinda out of my depth when it comes to stuff like this. 😅

[jordanbriere]

Untested in a real scenario, but try this: core.dll

Here's the basic test I ran:

from _messages import ProtobufMessage
from messages import UserMessage
from filters.recipients import RecipientFilter

message = UserMessage(RecipientFilter(), 'ShowMenu')
buffer = message.buffer
buffer.set_string('menu_string', 'blah blah blah')
copy = ProtobufMessage.from_abstract_pointer(buffer)
assert buffer.debug_string == copy.debug_string

[vinci6k]

Tried this (going by how it's done here) inside message/hooks.py:

buffer = ProtobufMessage.from_abstract_pointer(args[3])

And I got this:

[SP] Caught an Exception:
Traceback (most recent call last):
  File "..\addons\source-python\packages\source-python\messages\hooks.py", line 191, in _pre_send_user_message
    buffer = make_object(ProtobufMessage, args[3])
RuntimeError: Access violation - no RTTI data!

During handling of the above exception, another exception occurred:
Traceback (most recent call last):
  File "..\addons\source-python\packages\source-python\messages\hooks.py", line 199, in _pre_send_user_message
    buffer = ProtobufMessage.from_abstract_pointer(args[3])

RuntimeError: Access violation - no RTTI data!

[jordanbriere]

Hmm, that's weird. Updated the build above, what's the last number you get?

[vinci6k]

Seems to be 3:

1
2
3

[SP] Caught an Exception:
Traceback (most recent call last):
  File "..\addons\source-python\packages\source-python\messages\hooks.py", line 191, in _pre_send_user_message
    buffer = make_object(ProtobufMessage, args[3])
RuntimeError: Access violation - no RTTI data!

During handling of the above exception, another exception occurred:
Traceback (most recent call last):
  File "..\addons\source-python\packages\source-python\messages\hooks.py", line 199, in _pre_send_user_message
    buffer = ProtobufMessage.from_abstract_pointer(args[3])

RuntimeError: Access violation - no RTTI data!

[jordanbriere]

Then that means Message::MergeFrom itself internally does some dynamic type checking. Try the updated build above.

[vinci6k]

It works perfectly!

263
0
Admin Menu:
->1. Player Commands
->2. Server Commands
->3. Voting Commands

->9. Exit