Added logging of chat messages in the plugin API.

This commit is contained in:
Jan Vidar Krey 2010-08-11 18:44:02 +02:00
parent 5419d07efe
commit 4c960cb977
4 changed files with 89 additions and 80 deletions

View File

@ -51,9 +51,9 @@ int hub_handle_message(struct hub_info* hub, struct hub_user* u, const char* lin
{ {
int ret = 0; int ret = 0;
struct adc_message* cmd = 0; struct adc_message* cmd = 0;
LOG_PROTO("recv %s: %s", sid_to_string(u->id.sid), line); LOG_PROTO("recv %s: %s", sid_to_string(u->id.sid), line);
if (user_is_disconnecting(u)) if (user_is_disconnecting(u))
return -1; return -1;
@ -112,7 +112,7 @@ int hub_handle_message(struct hub_info* hub, struct hub_user* u, const char* lin
CHECK_CHAT_ONLY; CHECK_CHAT_ONLY;
CHECK_FLOOD(connect, 1); CHECK_FLOOD(connect, 1);
ROUTE_MSG; ROUTE_MSG;
default: default:
CHECK_FLOOD(extras, 1); CHECK_FLOOD(extras, 1);
ROUTE_MSG; ROUTE_MSG;
@ -126,7 +126,7 @@ int hub_handle_message(struct hub_info* hub, struct hub_user* u, const char* lin
ret = -1; ret = -1;
} }
} }
return ret; return ret;
} }
@ -167,7 +167,7 @@ int hub_handle_support(struct hub_info* hub, struct hub_user* u, struct adc_mess
{ {
ok = 0; ok = 0;
} }
index++; index++;
hub_free(arg); hub_free(arg);
arg = adc_msg_get_argument(cmd, index); arg = adc_msg_get_argument(cmd, index);
@ -245,7 +245,7 @@ int hub_handle_password(struct hub_info* hub, struct hub_user* u, struct adc_mes
ret = -1; ret = -1;
} }
} }
hub_free(password); hub_free(password);
return ret; return ret;
} }
@ -257,6 +257,7 @@ int hub_handle_chat_message(struct hub_info* hub, struct hub_user* u, struct adc
int ret = 0; int ret = 0;
int relay = 1; int relay = 1;
int broadcast; int broadcast;
int private_msg;
int command; int command;
int offset; int offset;
@ -269,7 +270,8 @@ int hub_handle_chat_message(struct hub_info* hub, struct hub_user* u, struct adc
return 0; return 0;
} }
broadcast = (cmd->cache[0] == 'B' || cmd->cache[0] == 'F'); broadcast = (cmd->cache[0] == 'B');
private_msg = (cmd->cache[0] == 'D' || cmd->cache[0] == 'E');
command = (message[0] == '!' || message[0] == '+'); command = (message[0] == '!' || message[0] == '+');
if (broadcast && command) if (broadcast && command)
@ -297,7 +299,6 @@ int hub_handle_chat_message(struct hub_info* hub, struct hub_user* u, struct adc
relay = 0; relay = 0;
} }
if (relay) if (relay)
{ {
plugin_st status; plugin_st status;
@ -305,7 +306,7 @@ int hub_handle_chat_message(struct hub_info* hub, struct hub_user* u, struct adc
{ {
status = plugin_handle_chat_message(hub, u, message, 0); status = plugin_handle_chat_message(hub, u, message, 0);
} }
else else if (private_msg)
{ {
struct hub_user* target = uman_get_user_by_sid(hub, cmd->target); struct hub_user* target = uman_get_user_by_sid(hub, cmd->target);
status = plugin_handle_private_message(hub, u, target, message, 0); status = plugin_handle_private_message(hub, u, target, message, 0);
@ -318,10 +319,11 @@ int hub_handle_chat_message(struct hub_info* hub, struct hub_user* u, struct adc
if (relay) if (relay)
{ {
/* adc_msg_remove_named_argument(cmd, "PM"); */ /* adc_msg_remove_named_argument(cmd, "PM"); */
if (broadcast)
/* FIXME: Plugin should do history management */ {
if (cmd->cache[0] == 'B')
hub_chat_history_add(hub, u, cmd); hub_chat_history_add(hub, u, cmd);
plugin_log_chat_message(hub, u, message, 0);
}
ret = route_message(hub, u, cmd); ret = route_message(hub, u, cmd);
} }
hub_free(message); hub_free(message);
@ -391,7 +393,7 @@ void hub_send_hubinfo(struct hub_info* hub, struct hub_user* u)
{ {
struct adc_message* info = adc_msg_copy(hub->command_info); struct adc_message* info = adc_msg_copy(hub->command_info);
int value = 0; int value = 0;
if (user_flag_get(u, feature_ping)) if (user_flag_get(u, feature_ping))
{ {
/* /*
@ -405,47 +407,47 @@ void hub_send_hubinfo(struct hub_info* hub, struct hub_user* u)
adc_msg_add_named_argument(info, "MC", uhub_itoa(hub_get_max_user_count(hub))); adc_msg_add_named_argument(info, "MC", uhub_itoa(hub_get_max_user_count(hub)));
adc_msg_add_named_argument(info, "SS", uhub_ulltoa(hub_get_shared_size(hub))); adc_msg_add_named_argument(info, "SS", uhub_ulltoa(hub_get_shared_size(hub)));
adc_msg_add_named_argument(info, "SF", uhub_itoa(hub_get_shared_files(hub))); adc_msg_add_named_argument(info, "SF", uhub_itoa(hub_get_shared_files(hub)));
/* Maximum/minimum share size */ /* Maximum/minimum share size */
value = hub_get_max_share(hub); value = hub_get_max_share(hub);
if (value) adc_msg_add_named_argument(info, "XS", uhub_itoa(value)); if (value) adc_msg_add_named_argument(info, "XS", uhub_itoa(value));
value = hub_get_min_share(hub); value = hub_get_min_share(hub);
if (value) adc_msg_add_named_argument(info, "MS", uhub_itoa(value)); if (value) adc_msg_add_named_argument(info, "MS", uhub_itoa(value));
/* Maximum/minimum upload slots allowed per user */ /* Maximum/minimum upload slots allowed per user */
value = hub_get_max_slots(hub); value = hub_get_max_slots(hub);
if (value) adc_msg_add_named_argument(info, "XL", uhub_itoa(value)); if (value) adc_msg_add_named_argument(info, "XL", uhub_itoa(value));
value = hub_get_min_slots(hub); value = hub_get_min_slots(hub);
if (value) adc_msg_add_named_argument(info, "ML", uhub_itoa(value)); if (value) adc_msg_add_named_argument(info, "ML", uhub_itoa(value));
/* guest users must be on min/max hubs */ /* guest users must be on min/max hubs */
value = hub_get_max_hubs_user(hub); value = hub_get_max_hubs_user(hub);
if (value) adc_msg_add_named_argument(info, "XU", uhub_itoa(value)); if (value) adc_msg_add_named_argument(info, "XU", uhub_itoa(value));
value = hub_get_min_hubs_user(hub); value = hub_get_min_hubs_user(hub);
if (value) adc_msg_add_named_argument(info, "MU", uhub_itoa(value)); if (value) adc_msg_add_named_argument(info, "MU", uhub_itoa(value));
/* registered users must be on min/max hubs */ /* registered users must be on min/max hubs */
value = hub_get_max_hubs_reg(hub); value = hub_get_max_hubs_reg(hub);
if (value) adc_msg_add_named_argument(info, "XR", uhub_itoa(value)); if (value) adc_msg_add_named_argument(info, "XR", uhub_itoa(value));
value = hub_get_min_hubs_reg(hub); value = hub_get_min_hubs_reg(hub);
if (value) adc_msg_add_named_argument(info, "MR", uhub_itoa(value)); if (value) adc_msg_add_named_argument(info, "MR", uhub_itoa(value));
/* operators must be on min/max hubs */ /* operators must be on min/max hubs */
value = hub_get_max_hubs_op(hub); value = hub_get_max_hubs_op(hub);
if (value) adc_msg_add_named_argument(info, "XO", uhub_itoa(value)); if (value) adc_msg_add_named_argument(info, "XO", uhub_itoa(value));
value = hub_get_min_hubs_op(hub); value = hub_get_min_hubs_op(hub);
if (value) adc_msg_add_named_argument(info, "MO", uhub_itoa(value)); if (value) adc_msg_add_named_argument(info, "MO", uhub_itoa(value));
/* uptime in seconds */ /* uptime in seconds */
adc_msg_add_named_argument(info, "UP", uhub_itoa((int) difftime(time(0), hub->tm_started))); adc_msg_add_named_argument(info, "UP", uhub_itoa((int) difftime(time(0), hub->tm_started)));
} }
if (user_is_connecting(u) || user_is_logged_in(u)) if (user_is_connecting(u) || user_is_logged_in(u))
{ {
route_to_user(hub, u, info); route_to_user(hub, u, info);
} }
adc_msg_free(info); adc_msg_free(info);
/* Only send banner when connecting */ /* Only send banner when connecting */
if (hub->config->show_banner && user_is_connecting(u)) if (hub->config->show_banner && user_is_connecting(u))
{ {
@ -525,14 +527,14 @@ static void hub_event_dispatcher(void* callback_data, struct event_data* message
struct hub_info* hub = (struct hub_info*) callback_data; struct hub_info* hub = (struct hub_info*) callback_data;
struct hub_user* user = (struct hub_user*) message->ptr; struct hub_user* user = (struct hub_user*) message->ptr;
assert(hub != NULL); assert(hub != NULL);
switch (message->id) switch (message->id)
{ {
case UHUB_EVENT_USER_JOIN: case UHUB_EVENT_USER_JOIN:
{ {
if (user_is_disconnecting(user)) if (user_is_disconnecting(user))
break; break;
if (message->flags) if (message->flags)
{ {
hub_send_password_challenge(hub, user); hub_send_password_challenge(hub, user);
@ -552,7 +554,7 @@ static void hub_event_dispatcher(void* callback_data, struct event_data* message
hub_schedule_destroy_user(hub, user); hub_schedule_destroy_user(hub, user);
break; break;
} }
case UHUB_EVENT_USER_DESTROY: case UHUB_EVENT_USER_DESTROY:
{ {
user_destroy(user); user_destroy(user);
@ -842,7 +844,7 @@ void hub_plugins_load(struct hub_info* hub)
hub->plugins = hub_malloc_zero(sizeof(struct uhub_plugins)); hub->plugins = hub_malloc_zero(sizeof(struct uhub_plugins));
if (!hub->plugins) if (!hub->plugins)
return; return;
if (plugin_initialize(hub->config, hub->plugins) < 0) if (plugin_initialize(hub->config, hub->plugins) < 0)
{ {
hub_free(hub->plugins); hub_free(hub->plugins);
@ -868,18 +870,18 @@ void hub_set_variables(struct hub_info* hub, struct acl_handle* acl)
char buf[MAX_RECV_BUF]; char buf[MAX_RECV_BUF];
char* tmp; char* tmp;
char* server = adc_msg_escape(PRODUCT_STRING); /* FIXME: OOM */ char* server = adc_msg_escape(PRODUCT_STRING); /* FIXME: OOM */
hub->acl = acl; hub->acl = acl;
hub->command_info = adc_msg_construct(ADC_CMD_IINF, 15); hub->command_info = adc_msg_construct(ADC_CMD_IINF, 15);
if (hub->command_info) if (hub->command_info)
{ {
adc_msg_add_named_argument(hub->command_info, ADC_INF_FLAG_CLIENT_TYPE, ADC_CLIENT_TYPE_HUB); adc_msg_add_named_argument(hub->command_info, ADC_INF_FLAG_CLIENT_TYPE, ADC_CLIENT_TYPE_HUB);
adc_msg_add_named_argument(hub->command_info, ADC_INF_FLAG_USER_AGENT, server); adc_msg_add_named_argument(hub->command_info, ADC_INF_FLAG_USER_AGENT, server);
tmp = adc_msg_escape(hub->config->hub_name); tmp = adc_msg_escape(hub->config->hub_name);
adc_msg_add_named_argument(hub->command_info, ADC_INF_FLAG_NICK, tmp); adc_msg_add_named_argument(hub->command_info, ADC_INF_FLAG_NICK, tmp);
hub_free(tmp); hub_free(tmp);
tmp = adc_msg_escape(hub->config->hub_description); tmp = adc_msg_escape(hub->config->hub_description);
adc_msg_add_named_argument(hub->command_info, ADC_INF_FLAG_DESCRIPTION, tmp); adc_msg_add_named_argument(hub->command_info, ADC_INF_FLAG_DESCRIPTION, tmp);
hub_free(tmp); hub_free(tmp);
@ -1064,7 +1066,7 @@ void hub_send_status(struct hub_info* hub, struct hub_user* user, enum status_me
STATUS(40, msg_proto_obsolete_adc0, 0, -1, 1); STATUS(40, msg_proto_obsolete_adc0, 0, -1, 1);
} }
#undef STATUS #undef STATUS
escaped_text = adc_msg_escape(text); escaped_text = adc_msg_escape(text);
adc_msg_add_argument(cmd, code); adc_msg_add_argument(cmd, code);
@ -1146,42 +1148,42 @@ const char* hub_get_status_message(struct hub_info* hub, enum status_message msg
const char* hub_get_status_message_log(struct hub_info* hub, enum status_message msg) const char* hub_get_status_message_log(struct hub_info* hub, enum status_message msg)
{ {
#define STATUS(MSG) case status_ ## MSG : return #MSG; break #define STATUS(MSG) case status_ ## MSG : return #MSG; break
switch (msg) switch (msg)
{ {
STATUS(msg_hub_full); STATUS(msg_hub_full);
STATUS(msg_hub_disabled); STATUS(msg_hub_disabled);
STATUS(msg_hub_registered_users_only); STATUS(msg_hub_registered_users_only);
STATUS(msg_inf_error_nick_missing); STATUS(msg_inf_error_nick_missing);
STATUS(msg_inf_error_nick_multiple); STATUS(msg_inf_error_nick_multiple);
STATUS(msg_inf_error_nick_invalid); STATUS(msg_inf_error_nick_invalid);
STATUS(msg_inf_error_nick_long); STATUS(msg_inf_error_nick_long);
STATUS(msg_inf_error_nick_short); STATUS(msg_inf_error_nick_short);
STATUS(msg_inf_error_nick_spaces); STATUS(msg_inf_error_nick_spaces);
STATUS(msg_inf_error_nick_bad_chars); STATUS(msg_inf_error_nick_bad_chars);
STATUS(msg_inf_error_nick_not_utf8); STATUS(msg_inf_error_nick_not_utf8);
STATUS(msg_inf_error_nick_taken); STATUS(msg_inf_error_nick_taken);
STATUS(msg_inf_error_nick_restricted); STATUS(msg_inf_error_nick_restricted);
STATUS(msg_inf_error_cid_invalid); STATUS(msg_inf_error_cid_invalid);
STATUS(msg_inf_error_cid_missing); STATUS(msg_inf_error_cid_missing);
STATUS(msg_inf_error_cid_taken); STATUS(msg_inf_error_cid_taken);
STATUS(msg_inf_error_pid_missing); STATUS(msg_inf_error_pid_missing);
STATUS(msg_inf_error_pid_invalid); STATUS(msg_inf_error_pid_invalid);
STATUS(msg_ban_permanently); STATUS(msg_ban_permanently);
STATUS(msg_ban_temporarily); STATUS(msg_ban_temporarily);
STATUS(msg_auth_invalid_password); STATUS(msg_auth_invalid_password);
STATUS(msg_auth_user_not_found); STATUS(msg_auth_user_not_found);
STATUS(msg_error_no_memory); STATUS(msg_error_no_memory);
STATUS(msg_user_share_size_low); STATUS(msg_user_share_size_low);
STATUS(msg_user_share_size_high); STATUS(msg_user_share_size_high);
STATUS(msg_user_slots_low); STATUS(msg_user_slots_low);
STATUS(msg_user_slots_high); STATUS(msg_user_slots_high);
STATUS(msg_user_hub_limit_low); STATUS(msg_user_hub_limit_low);
STATUS(msg_user_hub_limit_high); STATUS(msg_user_hub_limit_high);
STATUS(msg_proto_no_common_hash); STATUS(msg_proto_no_common_hash);
STATUS(msg_proto_obsolete_adc0); STATUS(msg_proto_obsolete_adc0);
} }
#undef STATUS #undef STATUS
return "unknown"; return "unknown";
} }
@ -1291,7 +1293,7 @@ void hub_event_loop(struct hub_info* hub)
event_queue_process(hub->queue); event_queue_process(hub->queue);
} }
while (hub->status == hub_status_running || hub->status == hub_status_disabled); while (hub->status == hub_status_running || hub->status == hub_status_disabled);
if (hub->status == hub_status_shutdown) if (hub->status == hub_status_shutdown)
{ {
@ -1322,11 +1324,11 @@ void hub_disconnect_user(struct hub_info* hub, struct hub_user* user, int reason
user->connection = 0; user->connection = 0;
LOG_TRACE("hub_disconnect_user(), user=%p, reason=%d, state=%d", user, reason, user->state); LOG_TRACE("hub_disconnect_user(), user=%p, reason=%d, state=%d", user, reason, user->state);
need_notify = user_is_logged_in(user) && hub->status == hub_status_running; need_notify = user_is_logged_in(user) && hub->status == hub_status_running;
user->quit_reason = reason; user->quit_reason = reason;
user_set_state(user, state_cleanup); user_set_state(user, state_cleanup);
if (need_notify) if (need_notify)
{ {
memset(&post, 0, sizeof(post)); memset(&post, 0, sizeof(post));

View File

@ -63,15 +63,10 @@
}); \ }); \
return status return status
#define PLUGIN_INVOKE_1(HUB, FUNCNAME, ARG1) \ #define PLUGIN_INVOKE_1(HUB, FUNCNAME, ARG1) INVOKE(HUB, FUNCNAME, { plugin->funcs.FUNCNAME(plugin, ARG1); })
INVOKE(HUB, FUNCNAME, { \ #define PLUGIN_INVOKE_2(HUB, FUNCNAME, ARG1, ARG2) INVOKE(HUB, FUNCNAME, { plugin->funcs.FUNCNAME(plugin, ARG1, ARG2); })
plugin->funcs.FUNCNAME(plugin, ARG1); \ #define PLUGIN_INVOKE_3(HUB, FUNCNAME, ARG1, ARG2, ARG3) INVOKE(HUB, FUNCNAME, { plugin->funcs.FUNCNAME(plugin, ARG1, ARG2, ARG3); })
})
#define PLUGIN_INVOKE_2(HUB, FUNCNAME, ARG1, ARG2) \
INVOKE(HUB, FUNCNAME, { \
plugin->funcs.FUNCNAME(plugin, ARG1, ARG2); \
})
static void convert_user_type(struct plugin_user* puser, struct hub_user* user) static void convert_user_type(struct plugin_user* puser, struct hub_user* user)
{ {
@ -138,7 +133,14 @@ void plugin_log_user_update_error(struct hub_info* hub, struct hub_user* who, co
struct plugin_user user; struct plugin_user user;
convert_user_type(&user, who); convert_user_type(&user, who);
PLUGIN_INVOKE_2(hub, on_user_update_error, &user, reason); PLUGIN_INVOKE_2(hub, on_user_update_error, &user, reason);
} }
void plugin_log_chat_message(struct hub_info* hub, struct hub_user* who, const char* message, int flags)
{
struct plugin_user user;
convert_user_type(&user, who);
PLUGIN_INVOKE_3(hub, on_user_chat_message, &user, message, flags);
}
plugin_st plugin_handle_chat_message(struct hub_info* hub, struct hub_user* from, const char* message, int flags) plugin_st plugin_handle_chat_message(struct hub_info* hub, struct hub_user* from, const char* message, int flags)
{ {

View File

@ -28,6 +28,7 @@
struct hub_info; struct hub_info;
struct ip_addr_encap; struct ip_addr_encap;
/* All log related functions */
void plugin_log_connection_accepted(struct hub_info* hub, struct ip_addr_encap* addr); void plugin_log_connection_accepted(struct hub_info* hub, struct ip_addr_encap* addr);
void plugin_log_connection_denied(struct hub_info* hub, struct ip_addr_encap* addr); void plugin_log_connection_denied(struct hub_info* hub, struct ip_addr_encap* addr);
void plugin_log_user_login_success(struct hub_info* hub, struct hub_user* user); void plugin_log_user_login_success(struct hub_info* hub, struct hub_user* user);
@ -35,11 +36,13 @@ void plugin_log_user_login_error(struct hub_info* hub, struct hub_user* user, co
void plugin_log_user_logout(struct hub_info* hub, struct hub_user* user, const char* reason); void plugin_log_user_logout(struct hub_info* hub, struct hub_user* user, const char* reason);
void plugin_log_user_nick_change(struct hub_info* hub, struct hub_user* user, const char* new_nick); void plugin_log_user_nick_change(struct hub_info* hub, struct hub_user* user, const char* new_nick);
void plugin_log_user_update_error(struct hub_info* hub, struct hub_user* user, const char* reason); void plugin_log_user_update_error(struct hub_info* hub, struct hub_user* user, const char* reason);
void plugin_log_chat_message(struct hub_info* hub, struct hub_user* from, const char* message, int flags);
/* IP ban related */ /* IP ban related */
plugin_st plugin_check_ip_early(struct hub_info* hub, struct ip_addr_encap* addr); plugin_st plugin_check_ip_early(struct hub_info* hub, struct ip_addr_encap* addr);
plugin_st plugin_check_ip_late(struct hub_info* hub, struct ip_addr_encap* addr); plugin_st plugin_check_ip_late(struct hub_info* hub, struct ip_addr_encap* addr);
/* Nickname allow/deny handling */
plugin_st plugin_check_nickname_valid(struct hub_info* hub, const char* nick); plugin_st plugin_check_nickname_valid(struct hub_info* hub, const char* nick);
plugin_st plugin_check_nickname_reserved(struct hub_info* hub, const char* nick); plugin_st plugin_check_nickname_reserved(struct hub_info* hub, const char* nick);

View File

@ -96,6 +96,7 @@ typedef void (*on_user_login_error_t)(struct plugin_handle*, struct plugin_user*
typedef void (*on_user_logout_t)(struct plugin_handle*, struct plugin_user*, const char* reason); typedef void (*on_user_logout_t)(struct plugin_handle*, struct plugin_user*, const char* reason);
typedef void (*on_user_nick_change_t)(struct plugin_handle*, struct plugin_user*, const char* new_nick); typedef void (*on_user_nick_change_t)(struct plugin_handle*, struct plugin_user*, const char* new_nick);
typedef void (*on_user_update_error_t)(struct plugin_handle*, struct plugin_user*, const char* reason); typedef void (*on_user_update_error_t)(struct plugin_handle*, struct plugin_user*, const char* reason);
typedef void (*on_user_chat_msg_t)(struct plugin_handle*, struct plugin_user*, const char* message, int flags);
typedef plugin_st (*on_change_nick_t)(struct plugin_handle*, struct plugin_user*, const char* new_nick); typedef plugin_st (*on_change_nick_t)(struct plugin_handle*, struct plugin_user*, const char* new_nick);
@ -112,12 +113,13 @@ typedef plugin_st (*auth_delete_user_t)(struct plugin_handle*, struct auth_info*
struct plugin_funcs struct plugin_funcs
{ {
// Log events for users // Log events for users
on_user_connect_t on_user_connect; /* A user has connected to the hub */ on_user_connect_t on_user_connect; /* A user has connected to the hub */
on_user_login_t on_user_login; /* A user has successfully logged in to the hub */ on_user_login_t on_user_login; /* A user has successfully logged in to the hub */
on_user_login_error_t on_user_login_error; /* A user has failed to log in to the hub */ on_user_login_error_t on_user_login_error; /* A user has failed to log in to the hub */
on_user_logout_t on_user_logout; /* A user has logged out of the hub (was previously logged in) */ on_user_logout_t on_user_logout; /* A user has logged out of the hub (was previously logged in) */
on_user_nick_change_t on_user_nick_change; /* A user has changed nickname */ on_user_nick_change_t on_user_nick_change; /* A user has changed nickname */
on_user_update_error_t on_user_update_error;/* A user has failed to update - nickname, etc. */ on_user_update_error_t on_user_update_error;/* A user has failed to update - nickname, etc. */
on_user_chat_msg_t on_user_chat_message;/* A user has sent a public chat message */
// Activity events (can be intercepted and refused by a plugin) // Activity events (can be intercepted and refused by a plugin)
on_chat_msg_t on_chat_msg; /* A public chat message is about to be sent (can be intercepted) */ on_chat_msg_t on_chat_msg; /* A public chat message is about to be sent (can be intercepted) */