]> jfr.im git - irc/quakenet/newserv.git/blame - newsearch/newsearch.h
Implement 'reason' provider for whowas search.
[irc/quakenet/newserv.git] / newsearch / newsearch.h
CommitLineData
16cc6e32 1#include "../nick/nick.h"
a92bb8e1 2#include "../lib/sstring.h"
56a84a81
IB
3#include "../parser/parser.h"
4#include "../channel/channel.h"
5#include "../lib/flags.h"
e8ad630b 6#include "../authext/authext.h"
a92bb8e1 7#include "../patricia/patricia.h"
0eb4cbd3 8#include "../whowas/whowas.h"
c86edd1d 9
1188d606
P
10#ifndef __NEWSEARCH_H
11#define __NEWSEARCH_H
12
f16cabe4 13#define NSMAX_KILL_LIMIT 500
16cc6e32 14#define NSMAX_GLINE_LIMIT 500
22f7c5c6 15
16cc6e32
IB
16/* gline duration, in seconds */
17#define NSGLINE_DURATION 3600
18
96429168 19#define NSMAX_REASON_LEN 120
4622c762 20#define NSMAX_NOTICE_LEN 250
a92bb8e1 21#define NSMAX_COMMAND_LEN 20
16cc6e32 22
c86edd1d
Q
23#define RETURNTYPE_BOOL 0x01
24#define RETURNTYPE_INT 0x02
25#define RETURNTYPE_STRING 0x03
26#define RETURNTYPE_TYPE 0xFF
27#define RETURNTYPE_CONST 0x100
28
b697c21c
CP
29#define VARIABLE_LEN 10
30#define MAX_VARIABLES 10
31
c86edd1d 32struct searchNode;
c8be5183 33struct searchCtx;
b697c21c 34struct coercedata;
c86edd1d 35
f33f3f52 36typedef struct searchNode *(*searchParseFunc)(struct searchCtx *ctx, char *input);
c8be5183 37typedef void (*replyFunc)(nick *np, char *format, ...);
0da2a4ae 38typedef void (*wallFunc)(int level, char *format, ...);
c8be5183 39
f33f3f52 40typedef struct searchNode *(*parseFunc)(struct searchCtx *, int, char **);
b697c21c
CP
41typedef void (*freeFunc)(struct searchCtx *, struct searchNode *);
42typedef void *(*exeFunc)(struct searchCtx *, struct searchNode *, void *);
43typedef void (*ChanDisplayFunc)(struct searchCtx *, nick *, chanindex *);
44typedef void (*NickDisplayFunc)(struct searchCtx *, nick *, nick *);
45typedef void (*UserDisplayFunc)(struct searchCtx *, nick *, authname *);
0eb4cbd3 46typedef void (*WhowasDisplayFunc)(struct searchCtx *, nick *, whowas *);
b697c21c
CP
47typedef void (*HeaderFunc)(void *sender, void *arg);
48
49struct coercedata {
50 struct searchNode *child;
51 union {
52 char *stringbuf;
53 unsigned long val;
54 } u;
55};
56
57typedef struct searchNode {
58 int returntype;
59 exeFunc exe;
60 freeFunc free;
61 void *localdata;
62} searchNode;
63
64struct searchVariable {
65 char name[VARIABLE_LEN];
66 struct searchNode data;
67 struct coercedata cdata;
68};
69
a92bb8e1
P
70typedef struct searchCmd {
71 void *defaultdisplayfunc;
72 sstring *name;
73 CommandHandler handler;
74 struct CommandTree *outputtree;
75 struct CommandTree *searchtree;
76} searchCmd;
77
78typedef struct searchList {
79 void *cmd;
80 sstring *name;
e8ff7b61 81 char *help;
a92bb8e1
P
82 struct searchList *next;
83} searchList;
84
c8be5183
CP
85typedef struct searchCtx {
86 searchParseFunc parser;
87 replyFunc reply;
0da2a4ae 88 wallFunc wall;
0a659cde 89 void *arg;
b697c21c
CP
90 struct searchVariable vars[MAX_VARIABLES];
91 int lastvar;
a92bb8e1 92 struct searchCmd *searchcmd;
e8ff7b61 93 nick *sender;
6b2202d0
CP
94 int limit;
95 void *displayfn;
c8be5183
CP
96} searchCtx;
97
c86edd1d 98/* Core functions */
c7f7a584 99/* Logical (BOOL -> BOOL)*/
f33f3f52
P
100struct searchNode *and_parse(searchCtx *ctx, int argc, char **argv);
101struct searchNode *not_parse(searchCtx *ctx, int argc, char **argv);
102struct searchNode *or_parse(searchCtx *ctx, int argc, char **argv);
c7f7a584 103
104/* Comparison (INT -> BOOL) */
f33f3f52
P
105struct searchNode *eq_parse(searchCtx *ctx, int argc, char **argv);
106struct searchNode *lt_parse(searchCtx *ctx, int argc, char **argv);
107struct searchNode *gt_parse(searchCtx *ctx, int argc, char **argv);
c7f7a584 108
109/* String match (STRING -> BOOL) */
f33f3f52
P
110struct searchNode *match_parse(searchCtx *ctx, int argc, char **argv);
111struct searchNode *regex_parse(searchCtx *ctx, int argc, char **argv);
c7f7a584 112
113/* Length (STRING -> INT) */
f33f3f52 114struct searchNode *length_parse(searchCtx *ctx, int argc, char **argv);
c7f7a584 115
116/* kill/gline actions (BOOL) */
f33f3f52
P
117struct searchNode *kill_parse(searchCtx *ctx, int argc, char **argv);
118struct searchNode *gline_parse(searchCtx *ctx, int argc, char **argv);
c7f7a584 119
4622c762 120/* notice action (BOOL) */
f33f3f52 121struct searchNode *notice_parse(searchCtx *ctx, int argc, char **argv);
4622c762 122
c7f7a584 123/* Nick/Channel functions (various types) */
f33f3f52
P
124struct searchNode *nick_parse(searchCtx *ctx, int argc, char **argv);
125struct searchNode *modes_parse(searchCtx *ctx, int argc, char **argv);
c7f7a584 126
127/* Nick functions (various types) */
f33f3f52
P
128struct searchNode *hostmask_parse(searchCtx *ctx, int argc, char **argv);
129struct searchNode *realname_parse(searchCtx *ctx, int argc, char **argv);
5144ddc4 130struct searchNode *away_parse(searchCtx *ctx, int argc, char **argv);
f33f3f52
P
131struct searchNode *authname_parse(searchCtx *ctx, int argc, char **argv);
132struct searchNode *authts_parse(searchCtx *ctx, int argc, char **argv);
133struct searchNode *ident_parse(searchCtx *ctx, int argc, char **argv);
134struct searchNode *host_parse(searchCtx *ctx, int argc, char **argv);
135struct searchNode *channel_parse(searchCtx *ctx, int argc, char **argv);
136struct searchNode *timestamp_parse(searchCtx *ctx, int argc, char **argv);
137struct searchNode *country_parse(searchCtx *ctx, int argc, char **argv);
138struct searchNode *ip_parse(searchCtx *ctx, int argc, char **argv);
139struct searchNode *channels_parse(searchCtx *ctx, int argc, char **argv);
140struct searchNode *server_parse(searchCtx *ctx, int argc, char **argv);
141struct searchNode *authid_parse(searchCtx *ctx, int argc, char **argv);
8a959859 142struct searchNode *cidr_parse(searchCtx *ctx, int argc, char **argv);
e3b5fea4 143struct searchNode *ipv6_parse(searchCtx *ctx, int argc, char **argv);
c7f7a584 144
0eb4cbd3
GB
145/* Whowas functions (various types) */
146struct searchNode *quit_parse(searchCtx *ctx, int argc, char **argv);
147struct searchNode *killed_parse(searchCtx *ctx, int argc, char **argv);
148struct searchNode *renamed_parse(searchCtx *ctx, int argc, char **argv);
149struct searchNode *age_parse(searchCtx *ctx, int argc, char **argv);
150struct searchNode *newnick_parse(searchCtx *ctx, int argc, char **argv);
8c50d8eb 151struct searchNode *reason_parse(searchCtx *ctx, int argc, char **argv);
0eb4cbd3 152
c7f7a584 153/* Channel functions (various types) */
f33f3f52
P
154struct searchNode *exists_parse(searchCtx *ctx, int argc, char **argv);
155struct searchNode *services_parse(searchCtx *ctx, int argc, char **argv);
156struct searchNode *size_parse(searchCtx *ctx, int argc, char **argv);
157struct searchNode *name_parse(searchCtx *ctx, int argc, char **argv);
158struct searchNode *topic_parse(searchCtx *ctx, int argc, char **argv);
159struct searchNode *oppct_parse(searchCtx *ctx, int argc, char **argv);
de8c57b4
C
160struct searchNode *cumodecount_parse(searchCtx *ctx, int argc, char **argv);
161struct searchNode *cumodepct_parse(searchCtx *ctx, int argc, char **argv);
f33f3f52
P
162struct searchNode *hostpct_parse(searchCtx *ctx, int argc, char **argv);
163struct searchNode *authedpct_parse(searchCtx *ctx, int argc, char **argv);
164struct searchNode *kick_parse(searchCtx *ctx, int argc, char **argv);
c86edd1d 165
b697c21c 166/* Iteration functions */
f33f3f52
P
167struct searchNode *any_parse(searchCtx *ctx, int argc, char **argv);
168struct searchNode *all_parse(searchCtx *ctx, int argc, char **argv);
169struct searchNode *var_parse(searchCtx *ctx, int argc, char **argv);
b697c21c
CP
170
171/* Iteraterable functions */
f33f3f52 172struct searchNode *channeliter_parse(searchCtx *ctx, int argc, char **argv);
cb857218 173struct searchNode *nickiter_parse(searchCtx *ctx, int argc, char **argv);
b697c21c 174
90334b4c
CP
175/* Functions that operate on strings */
176struct searchNode *cumodes_parse(searchCtx *ctx, int argc, char **argv);
177
c7f7a584 178/* Force a node to return the thing you want */
c8be5183 179struct searchNode *coerceNode(searchCtx *ctx, struct searchNode *thenode, int type);
c7f7a584 180
c86edd1d 181/* Registration functions */
a92bb8e1
P
182searchCmd *registersearchcommand(char *name, int level, CommandHandler cmd, void *defaultdisplayfunc);
183void deregistersearchcommand(searchCmd *scmd);
e8ff7b61 184void registersearchterm(searchCmd *cmd, char *term, parseFunc parsefunc, int level, char *help);
a92bb8e1 185void deregistersearchterm(searchCmd *cmd, char *term, parseFunc parsefunc);
e8ff7b61
P
186
187void registerglobalsearchterm(char *term, parseFunc parsefunc, char *help);
a92bb8e1 188void deregisterglobalsearchterm(char *term, parseFunc parsefunc);
e8ff7b61
P
189
190void regdisp( searchCmd *cmd, const char *name, void *handler, int level, char *help);
a92bb8e1 191void unregdisp( searchCmd *cmd, const char *name, void *handler);
c86edd1d 192
2ba836f2
CP
193/* Special nick* printf */
194void nssnprintf(char *, size_t, const char *, nick *);
195
e3b5fea4 196void displaystrerror(replyFunc reply, nick *np, const char *input);
e3b5fea4 197
c86edd1d 198extern const char *parseError;
b697c21c 199extern nick *senderNSExtern;
6f8dfee9 200
3d2bf13b 201void printnick(searchCtx *, nick *, nick *);
e8ad630b 202void printuser(searchCtx *, nick *, authname *);
e1b0e499 203void printchannel(searchCtx *, nick *, chanindex *);
0eb4cbd3 204void printwhowas(searchCtx *, nick *, whowas *);
6f8dfee9 205
6b2202d0
CP
206void nicksearch_exe(struct searchNode *search, searchCtx *sctx);
207void chansearch_exe(struct searchNode *search, searchCtx *sctx);
208void usersearch_exe(struct searchNode *search, searchCtx *ctx);
0eb4cbd3 209void whowassearch_exe(struct searchNode *search, searchCtx *ctx);
20b9980a
CP
210
211int do_nicksearch_real(replyFunc reply, wallFunc wall, void *source, int cargc, char **cargv);
212int do_chansearch_real(replyFunc reply, wallFunc wall, void *source, int cargc, char **cargv);
e8ad630b 213int do_usersearch_real(replyFunc reply, wallFunc wall, void *source, int cargc, char **cargv);
0eb4cbd3 214int do_whowassearch_real(replyFunc reply, wallFunc wall, void *source, int cargc, char **cargv);
0a659cde
CP
215
216void *literal_exe(searchCtx *ctx, struct searchNode *thenode, void *theinput);
217void literal_free(searchCtx *ctx, struct searchNode *thenode);
218
f33f3f52
P
219struct searchVariable *var_register(searchCtx *ctx, char *arg, int type);
220searchNode *var_get(searchCtx *ctx, char *arg);
b697c21c
CP
221void var_setstr(struct searchVariable *v, char *data);
222
6b2202d0 223void newsearch_ctxinit(searchCtx *ctx, searchParseFunc searchfn, replyFunc replyfn, wallFunc wallfn, void *arg, searchCmd *cmd, nick *sender, void *displayfn, int limit);
b697c21c 224
0a659cde
CP
225/* AST functions */
226
227struct searchASTNode;
228
229#define AST_NODE_CHILD 1
230#define AST_NODE_LITERAL 2
231
232/* items to store in the ast lookup cache */
233#define AST_RECENT 10
234
68d05acb
CP
235struct searchASTExpr;
236
237typedef struct searchASTNode {
238 parseFunc fn;
239 int argc;
240 struct searchASTExpr *argv;
241} searchASTNode;
242
0a659cde
CP
243typedef struct searchASTExpr {
244 int type;
245 union {
246 char *literal;
68d05acb
CP
247 /* this was originally a pointer, but having it as one means you can't memcpy directly */
248 struct searchASTNode child;
0a659cde 249 } u;
0a659cde
CP
250} searchASTExpr;
251
e3b5fea4
P
252typedef struct searchASTCache {
253 searchASTExpr *tree;
254 searchASTExpr *cache[AST_RECENT];
255 int nextpos;
256} searchASTCache;
257
68d05acb
CP
258#define __NSASTSizeOfArray(x) (sizeof(x) / sizeof(x[0]))
259
260#define __NSASTExpr(x, y, ...) (searchASTExpr){.type = x, .u.y = __VA_ARGS__}
261#define __NSASTRawNode(x, c, y) (searchASTNode){.fn = x, .argc = c, .argv = y}
262
263#define __NSASTSizeNode(x, y) __NSASTRawNode(x, __NSASTSizeOfArray(y), y)
264#define __NSASTNode(x, ...) __NSASTSizeNode(x, ((searchASTExpr []){__VA_ARGS__}))
0a659cde 265
0a659cde
CP
266#define __NSASTChild(...) __NSASTExpr(AST_NODE_CHILD, child, __VA_ARGS__)
267
68d05acb 268#define NSASTLiteral(value) __NSASTExpr(AST_NODE_LITERAL, literal, value)
0a659cde 269#define NSASTNode(fn, ...) __NSASTChild(__NSASTNode(fn, __VA_ARGS__))
68d05acb 270#define NSASTManualNode(fn, count, children) __NSASTChild(__NSASTRawNode(fn, count, children))
0a659cde 271
f33f3f52 272searchNode *search_astparse(searchCtx *, char *);
0a659cde 273
2181a10f
CP
274int ast_nicksearch(searchASTExpr *tree, replyFunc reply, void *sender, wallFunc wall, NickDisplayFunc display, HeaderFunc header, void *headerarg, int limit);
275int ast_chansearch(searchASTExpr *tree, replyFunc reply, void *sender, wallFunc wall, ChanDisplayFunc display, HeaderFunc header, void *headerarg, int limit);
276int ast_usersearch(searchASTExpr *tree, replyFunc reply, void *sender, wallFunc wall, UserDisplayFunc display, HeaderFunc header, void *headerarg, int limit);
0eb4cbd3 277int ast_whowassearch(searchASTExpr *tree, replyFunc reply, void *sender, wallFunc wall, WhowasDisplayFunc display, HeaderFunc header, void *headerarg, int limit);
0a659cde 278
a92bb8e1
P
279char *ast_printtree(char *buf, size_t bufsize, searchASTExpr *expr, searchCmd *cmd);
280
6cb1b086 281int parseopts(int cargc, char **cargv, int *arg, int *limit, void **subset, void *display, CommandTree *sl, replyFunc reply, void *sender);
0a659cde 282
68d05acb
CP
283typedef int (*ASTFunc)(searchASTExpr *, replyFunc, void *, wallFunc, void *, HeaderFunc, void *, int limit);
284
0a659cde 285/* erk */
a92bb8e1
P
286extern searchList *globalterms;
287
288extern searchCmd *reg_nicksearch;
289extern searchCmd *reg_chansearch;
290extern searchCmd *reg_usersearch;
0eb4cbd3 291extern searchCmd *reg_whowassearch;
0a659cde 292
55dd7529
CP
293extern UserDisplayFunc defaultuserfn;
294extern NickDisplayFunc defaultnickfn;
295extern ChanDisplayFunc defaultchanfn;
0eb4cbd3 296extern WhowasDisplayFunc defaultwhowasfn;
55dd7529 297
31686847
CP
298struct searchNode *argtoconststr(char *command, searchCtx *ctx, char *arg, char **p);
299
1188d606 300#endif