newsearch/newsearch.h

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