include/hook.h

   1 /*
   2  * Copyright (C) 2004-2005 Lee Hardy <lee -at- leeh.co.uk>
   3  * Copyright (C) 2004-2005 ircd-ratbox development team
   4  */
   5 #ifndef INCLUDED_HOOK_H
   6 #define INCLUDED_HOOK_H
   7
   8 typedef struct
   9 {
  10         char *name;
  11         rb_dlink_list hooks;
  12 } hook;
  13
  14 enum hook_priority
  15 {
  16         HOOK_LOWEST = 10,
  17         HOOK_LOW = 20,
  18         HOOK_NORMAL = 30,
  19         HOOK_HIGH = 40,
  20         HOOK_HIGHEST = 50,
  21         HOOK_MONITOR = 100
  22 };
  23
  24 typedef void (*hookfn) (void *data);
  25
  26 extern int h_iosend_id;
  27 extern int h_iorecv_id;
  28 extern int h_iorecvctrl_id;
  29
  30 extern int h_burst_client;
  31 extern int h_burst_channel;
  32 extern int h_burst_finished;
  33 extern int h_server_introduced;
  34 extern int h_server_eob;
  35 extern int h_client_exit;
  36 extern int h_after_client_exit;
  37 extern int h_umode_changed;
  38 extern int h_new_local_user;
  39 extern int h_new_remote_user;
  40 extern int h_introduce_client;
  41 extern int h_can_kick;
  42 extern int h_privmsg_channel;
  43 extern int h_privmsg_user;
  44 extern int h_conf_read_start;
  45 extern int h_conf_read_end;
  46 extern int h_outbound_msgbuf;
  47 extern int h_rehash;
  48 extern int h_priv_change;
  49 extern int h_cap_change;
  50
  51 void init_hook(void);
  52 int register_hook(const char *name);
  53 void add_hook(const char *name, hookfn fn);
  54 void add_hook_prio(const char *name, hookfn fn, enum hook_priority priority);
  55 void remove_hook(const char *name, hookfn fn);
  56 void call_hook(int id, void *arg);
  57
  58 typedef struct
  59 {
  60         struct Client *client;
  61         void *arg1;
  62         void *arg2;
  63 } hook_data;
  64
  65 typedef struct
  66 {
  67         struct Client *client;
  68         const void *arg1;
  69         const void *arg2;
  70 } hook_cdata;
  71
  72 typedef struct
  73 {
  74         struct Client *client;
  75         const void *arg1;
  76         int arg2;
  77         int result;
  78 } hook_data_int;
  79
  80 typedef struct
  81 {
  82         struct Client *client;
  83         struct Client *target;
  84 } hook_data_client;
  85
  86 typedef struct
  87 {
  88         struct Client *client;
  89         struct Channel *chptr;
  90         int approved;
  91 } hook_data_channel;
  92
  93 typedef struct
  94 {
  95         struct Client *client;
  96         struct Channel *chptr;
  97         const char *key;
  98 } hook_data_channel_activity;
  99
 100 typedef struct
 101 {
 102         struct Client *client;
 103         struct Channel *chptr;
 104         struct membership *msptr;
 105         struct Client *target;
 106         int approved;
 107         int dir;
 108         const char *modestr;
 109         const char *error;
 110 } hook_data_channel_approval;
 111
 112 typedef struct
 113 {
 114         struct Client *client;
 115         struct Client *target;
 116         struct Channel *chptr;
 117         struct membership *clientms;
 118         struct membership *targetms;
 119         int approved;
 120 } hook_data_channel_visibility;
 121
 122 typedef struct
 123 {
 124         struct Client *client;
 125         struct Client *target;
 126         int approved;
 127 } hook_data_client_approval;
 128
 129 typedef struct
 130 {
 131         struct Client *local_link; /* local client originating this, or NULL */
 132         struct Client *target; /* dying client */
 133         struct Client *from; /* causing client (could be &me or target) */
 134         const char *comment;
 135 } hook_data_client_exit;
 136
 137 typedef struct
 138 {
 139         struct Client *client;
 140         const char *reason;
 141         const char *orig_reason;
 142 } hook_data_client_quit;
 143
 144 typedef struct
 145 {
 146         struct Client *client;
 147         unsigned int oldumodes;
 148         unsigned int oldsnomask;
 149 } hook_data_umode_changed;
 150
 151 typedef struct
 152 {
 153         struct Client *client;
 154         int oldcaps;
 155         int add;
 156         int del;
 157 } hook_data_cap_change;
 158
 159 enum message_type {
 160         MESSAGE_TYPE_NOTICE,
 161         MESSAGE_TYPE_PRIVMSG,
 162         MESSAGE_TYPE_PART,
 163         MESSAGE_TYPE_COUNT
 164 };
 165
 166 typedef struct
 167 {
 168         enum message_type msgtype;
 169         struct Client *source_p;
 170         struct Channel *chptr;
 171         const char *text;
 172         int approved;
 173 } hook_data_privmsg_channel;
 174
 175 typedef struct
 176 {
 177         enum message_type msgtype;
 178         struct Client *source_p;
 179         struct Client *target_p;
 180         const char *text;
 181         int approved;
 182 } hook_data_privmsg_user;
 183
 184 typedef struct
 185 {
 186         struct Client *client;
 187         struct PrivilegeSet *old;
 188         struct PrivilegeSet *new;
 189         const struct PrivilegeSet *added;
 190         const struct PrivilegeSet *removed;
 191         const struct PrivilegeSet *unchanged;
 192 } hook_data_priv_change;
 193
 194 typedef struct
 195 {
 196         bool signal;
 197 } hook_data_rehash;
 198
 199 #endif