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