core/hooks.h

   1 /* hooks.h */
   2
   3 #ifndef __HOOKS_H
   4 #define __HOOKS_H
   5
   6 #include <limits.h>
   7
   8 #define HOOKMAX 5000
   9
  10 /* This is the authoritative registry of all known hook numbers */
  11
  12 #define HOOK_CORE_REHASH             0  /* Argument is an int */
  13 #define HOOK_CORE_STATSREQUEST       1
  14 #define HOOK_CORE_STATSREPLY         2
  15 #define HOOK_CORE_ENDOFHOOKSQUEUE    3
  16 #define HOOK_CORE_STOPERROR          4
  17 #define HOOK_CORE_ERROR              5  /* Argument is a struct error_event * */
  18 #define HOOK_CORE_SIGUSR1            6
  19 #define HOOK_CORE_SIGINT             7
  20
  21 #define HOOK_IRC_CONNECTED         100  /* Located in server.c now to fix burst bug */
  22 #define HOOK_IRC_DISCON            101
  23 #define HOOK_IRC_SENDBURSTSERVERS  102  /* Located in server.c now to fix burst bug */
  24 #define HOOK_IRC_SENDBURSTNICKS    103  /* Located in server.c now to fix burst bug */
  25 #define HOOK_IRC_SENDBURSTBURSTS   104  /* Located in server.c now to fix burst bug */
  26 #define HOOK_IRC_PRE_DISCON        105
  27
  28 #define HOOK_SERVER_NEWSERVER      200  /* Argument is number of new server */
  29 #define HOOK_SERVER_LOSTSERVER     201  /* Argument is number of lost server */
  30 #define HOOK_SERVER_END_OF_BURST   202
  31 #define HOOK_SERVER_PRE_LOSTSERVER 203  /* Argument is number of lost server */
  32 #define HOOK_SERVER_LINKED         204  /* Argument is number of server */
  33
  34 #define HOOK_NICK_NEWNICK          300  /* Argument is nick* */
  35 #define HOOK_NICK_RENAME           301  /* Argument is nick* */
  36 #define HOOK_NICK_LOSTNICK         302  /* Argument is nick* */
  37 #define HOOK_NICK_WHOISCHANNELS    303  /* Argument is nick*[2] (sender, target) */
  38 #define HOOK_NICK_ACCOUNT          304  /* Argument is nick* */
  39 #define HOOK_NICK_QUIT             305  /* Argument is void*[2] (nick, reason) */
  40 #define HOOK_NICK_SETHOST          306  /* Argument is nick* */
  41 #define HOOK_NICK_MODEOPER         307  /* Argument is void*[2] (nick, modes) */
  42 #define HOOK_NICK_KILL             308  /* Argument is void*[2] (nick, reason) */
  43 #define HOOK_NICK_MASKPRIVMSG      309  /* Argument is void*[3] (nick, target, message) ** NICK COULD BE NULL ** */
  44
  45 #define HOOK_CHANNEL_BURST         400  /* Argument is channel pointer */
  46 #define HOOK_CHANNEL_CREATE        401  /* Argument is void*[2] (channel, nick) */
  47 #define HOOK_CHANNEL_JOIN          402  /* Argument is void*[2] (channel, nick) */
  48 #define HOOK_CHANNEL_PART          403  /* Argument is void*[3] (channel, nick, reason) */
  49 #define HOOK_CHANNEL_KICK          404  /* Argument is void*[4] (channel, kicked, kicker, reason) ** KICKER COULD BE NULL ***/
  50 #define HOOK_CHANNEL_TOPIC         405  /* Argument is void*[2] (channel, nick) ** NICK COULD BE NULL ** */
  51 #define HOOK_CHANNEL_MODECHANGE    406  /* Argument is void*[3] (channel, nick, flags) ** NICK COULD BE NULL ** */
  52 #define HOOK_CHANNEL_BANSET        407  /* Argument is void*[2] (channel, nick) ** NICK COULD BE NULL **, ban will be first ban on channel */
  53 #define HOOK_CHANNEL_BANCLEAR      408  /* Argument is void*[2] (channel, nick) ** NICK COULD BE NULL **, ban will be gone.  XXX - could we care what the ban was? */
  54 #define HOOK_CHANNEL_OPPED         409  /* Argument is void*[3] (channel, nick, target) ** NICK COULD BE NULL ** */
  55 #define HOOK_CHANNEL_DEOPPED       410  /* Argument is void*[3] (channel, nick, target) ** NICK COULD BE NULL ** */
  56 #define HOOK_CHANNEL_VOICED        411  /* Argument is void*[3] (channel, nick, target) ** NICK COULD BE NULL ** */
  57 #define HOOK_CHANNEL_DEVOICED      412  /* Argument is void*[3] (channel, nick, target) ** NICK COULD BE NULL ** */
  58
  59 #define HOOK_CHANNEL_NEWCHANNEL    413  /* Argument is channel pointer */
  60 #define HOOK_CHANNEL_LOSTCHANNEL   414  /* Argument is channel pointer */
  61
  62 #define HOOK_CHANNEL_NEWNICK       415  /* Argument is void*[2] (channel, nick) */
  63 #define HOOK_CHANNEL_LOSTNICK      416  /* Argument is void*[2] (channel, nick) */
  64
  65 #define HOOK_CHANSERV_DBLOADED     500 /* No arg */
  66 /* 501 spare for now */
  67 #define HOOK_CHANSERV_RUNNING      502 /* No arg */
  68
  69 #define HOOK_CONTROL_REGISTERED    600 /* Argument is nick* */
  70 #define HOOK_CONTROL_WHOISREQUEST  601 /* Argument is nick* */
  71 #define HOOK_CONTROL_WHOISREPLY    602 /* Argument is char* */
  72
  73 #define HOOK_SHADOW_SERVER         701 /* Argument is char* */
  74
  75 #define HOOK_AUTH_FLAGSUPDATED     801 /* Argument is void*[2] (authname*, u_int64_t*) */
  76 #define HOOK_AUTH_LOSTAUTHNAME     802 /* Argument is authname* */
  77
  78 #define HOOK_TRUSTS_DB_CLOSED      900 /* No arg */
  79 #define HOOK_TRUSTS_DB_LOADED      901 /* No arg */
  80 #define HOOK_TRUSTS_NEWNICK        902 /* Argument is void*[2] (nick*, long) */
  81 #define HOOK_TRUSTS_LOSTNICK       903 /* Argument is void*[2] (nick*, long) */
  82 #define HOOK_TRUSTS_NEWGROUP       904 /* Argument is trustgroup* */
  83 #define HOOK_TRUSTS_LOSTGROUP      905 /* Argument is trustgroup* */
  84 #define HOOK_TRUSTS_ADDGROUP       906 /* Argument is trustgroup* */
  85 #define HOOK_TRUSTS_DELGROUP       907 /* Argument is trustgroup* */
  86 #define HOOK_TRUSTS_ADDHOST        908 /* Argument is trusthost* */
  87 #define HOOK_TRUSTS_DELHOST        909 /* Argument is trusthost* */
  88 #define HOOK_TRUSTS_MODIFYGROUP    910 /* Argument is trustgroup* */
  89 #define HOOK_TRUSTS_LOSTHOST       911 /* Argument is trusthost* */
  90
  91 #define HOOK_TRUSTS_DBLOADED       1000
  92
  93 #define PRIORITY_DEFAULT           0
  94
  95 #define PRIORITY_MAX               LONG_MIN
  96 #define PRIORITY_MIN               LONG_MAX
  97
  98 typedef void (*HookCallback)(int, void *);
  99
 100 extern unsigned int hookqueuelength;
 101
 102 void inithooks();
 103 int registerhook(int hooknum, HookCallback callback);
 104 int deregisterhook(int hooknum, HookCallback callback);
 105 void triggerhook(int hooknum, void *arg);
 106 int registerpriorityhook(int hooknum, HookCallback callback, long priority);
 107
 108 #endif