| 1 |
# Atheme hooks system |
| 2 |
# |
| 3 |
# hook_add_event("NAME") |
| 4 |
# hook_call_NAME(argument) |
| 5 |
# hook_add_NAME(handler) |
| 6 |
# hook_add_first_NAME(handler) |
| 7 |
# hook_del_NAME(handler) |
| 8 |
# |
| 9 |
# Hooks that take a direct pointer to an object may not destroy that object. |
| 10 |
# If this is necessary it must be done in an event added from the hook. |
| 11 |
# Hooks with _can_ or _check_ in the name may fill in a field in the argument |
| 12 |
# structure to indicate what should happen. They are not allowed to destroy |
| 13 |
# the object. |
| 14 |
# channel_join, user_add and user_nickchange may destroy the object, by |
| 15 |
# setting the pointer in the argument structure to NULL, deleting the object |
| 16 |
# from Atheme's state and sending an appropriate message to ircd. Note that |
| 17 |
# channel_join may kick the user but may not clear the channel. |
| 18 |
# Most other hooks may not destroy the object or prevent the action. |
| 19 |
# |
| 20 |
# Current list of hooks |
| 21 |
# |
| 22 |
# Name Argument type |
| 23 |
# (main) |
| 24 |
config_purge void |
| 25 |
config_ready void |
| 26 |
db_write database_handle_t * |
| 27 |
|
| 28 |
# XXX: for groupserv. remove when we have proper dependency resolution in opensex. |
| 29 |
db_write_pre_ca database_handle_t * |
| 30 |
|
| 31 |
db_saved void |
| 32 |
shutdown void |
| 33 |
# (ircd) |
| 34 |
channel_add channel_t * |
| 35 |
channel_delete channel_t * |
| 36 |
channel_tschange channel_t * |
| 37 |
channel_join hook_channel_joinpart_t * |
| 38 |
channel_part hook_channel_joinpart_t * |
| 39 |
channel_mode hook_channel_mode_t * |
| 40 |
channel_mode_change hook_channel_mode_change_t * |
| 41 |
channel_topic channel_t * |
| 42 |
channel_can_change_topic hook_channel_topic_check_t * |
| 43 |
channel_message hook_cmessage_data_t * |
| 44 |
server_add server_t * |
| 45 |
server_eob server_t * |
| 46 |
server_delete hook_server_delete_t * |
| 47 |
user_add hook_user_nick_t * |
| 48 |
user_delete user_t * |
| 49 |
user_delete_info hook_user_delete_t * |
| 50 |
user_nickchange hook_user_nick_t * |
| 51 |
user_away user_t * |
| 52 |
user_deoper user_t * |
| 53 |
user_oper user_t * |
| 54 |
# (services) |
| 55 |
channel_can_register hook_channel_register_check_t * |
| 56 |
channel_drop mychan_t * |
| 57 |
channel_info hook_channel_req_t * |
| 58 |
channel_register hook_channel_req_t * |
| 59 |
channel_check_expire hook_expiry_req_t * |
| 60 |
channel_acl_change hook_channel_acl_req_t * |
| 61 |
group_drop mygroup_t * |
| 62 |
group_register mygroup_t * |
| 63 |
nick_can_register hook_user_register_check_t * |
| 64 |
nick_group hook_user_req_t * |
| 65 |
nick_check user_t * |
| 66 |
nick_enforce hook_nick_enforce_t * |
| 67 |
nick_ungroup hook_user_req_t * |
| 68 |
nick_check_expire hook_expiry_req_t * |
| 69 |
sasl_input sasl_message_t * |
| 70 |
service_introduce service_t * |
| 71 |
user_can_register hook_user_register_check_t * |
| 72 |
user_can_login hook_user_login_check_t * |
| 73 |
user_drop myuser_t * |
| 74 |
user_identify user_t * |
| 75 |
user_info hook_user_req_t * |
| 76 |
user_info_noexist hook_info_noexist_req_t * |
| 77 |
user_register myuser_t * |
| 78 |
user_verify_register hook_user_req_t * |
| 79 |
user_check_expire hook_expiry_req_t * |
| 80 |
user_rename hook_user_rename_t * |
| 81 |
user_sethost user_t * |
| 82 |
user_needforce hook_user_needforce_t * |
| 83 |
myuser_delete myuser_t * |
| 84 |
metadata_change hook_metadata_change_t * |
| 85 |
host_request hook_host_request_t * |
| 86 |
channel_pick_successor hook_channel_succession_req_t * |
| 87 |
channel_succession hook_channel_succession_req_t * |
| 88 |
grant_channel_access user_t * |
| 89 |
operserv_info sourceinfo_t * |
| 90 |
module_load hook_module_load_t * |
| 91 |
myentity_find hook_myentity_req_t * |
| 92 |
# (sasl) |
| 93 |
sasl_may_impersonate hook_sasl_may_impersonate_t * |