-/*
- * SmartRoute phase 1
- * connection rule patch
+/**
+ * @file
+ * @brief Connection rule parser and checker
+ * @version $Id$
+ *
* by Tony Vencill (Tonto on IRC) <vencill@bga.com>
*
- * The majority of this file is a recusive descent parser used to convert
+ * The majority of this file is a recursive descent parser used to convert
* connection rules into expression trees when the conf file is read.
* All parsing structures and types are hidden in the interest of good
* programming style and to make possible future data structure changes
* more closely simulate the actual ircd environment). crule_eval and
* the rule functions are made empty functions as in the stand-alone
* test parser.
+ *
+ * The production rules for the grammar are as follows ("rule" is the
+ * starting production):
+ *
+ * rule:
+ * orexpr END END is end of input or :
+ * orexpr:
+ * andexpr
+ * andexpr || orexpr
+ * andexpr:
+ * primary
+ * primary && andexpr
+ * primary:
+ * function
+ * ! primary
+ * ( orexpr )
+ * function:
+ * word ( ) word is alphanumeric string, first character
+ * word ( arglist ) must be a letter
+ * arglist:
+ * word
+ * word , arglist
*/
+#include "config.h"
+#include "crule.h"
#ifndef CR_DEBUG
/* ircd functions and types we need */
-#include "sys.h"
-#include "h.h"
-#include "struct.h"
-#include "s_serv.h"
+#include "client.h"
#include "ircd.h"
+#include "ircd_alloc.h"
+#include "ircd_chattr.h"
+#include "ircd_string.h"
#include "match.h"
#include "s_bsd.h"
-#include "common.h"
-#include "crule.h"
+#include "s_debug.h"
+#include "struct.h"
+
+#include <stdio.h>
+#include <stdlib.h>
#else /* includes and defines to make the stand-alone test parser */
-#include "sys.h"
#include <stdio.h>
-#include "h.h"
+#include <stdlib.h>
#define BadPtr(x) (!(x) || (*(x) == '\0'))
#define DupString(x,y) \
- do { \
- x = (char *)RunMalloc(strlen(y)+1); \
- strcpy(x,y); \
- } while(0)
+ do { \
+ x = (char*) MyMalloc(strlen(y)+1); \
+ strcpy(x,y); \
+ } while(0)
-/* We don't care about collation discrepacies here, it seems.... */
-#define strCasediff strcasecmp
+/* We don't care about collation discrepancies here, it seems.... */
+#define ircd_strcmp strcasecmp
#endif
-RCSTAG_CC("$Id$");
+#include <string.h>
+
#if defined(CR_DEBUG) || defined(CR_CHKCONF)
-#undef RunMalloc
+#undef MyMalloc
#undef malloc
-#define RunMalloc malloc
-#undef RunFree
+#define MyMalloc malloc
+#undef MyFree
#undef free
-#define RunFree free
+#define MyFree free
#endif
/* some constants and shared data types */
-#define CR_MAXARGLEN 80 /* why 80? why not? it's > hostname lengths */
-#define CR_MAXARGS 3 /* There's a better way to do this,
- but not now. */
+#define CR_MAXARGLEN 80 /**< Maximum arg length (must be > HOSTLEN) */
+#define CR_MAXARGS 3 /**< Maximum number of args for a rule */
/*
* Some symbols for easy reading
*/
+/** Input scanner tokens. */
enum crule_token {
- CR_UNKNOWN, CR_END, CR_AND, CR_OR, CR_NOT, CR_OPENPAREN, CR_CLOSEPAREN,
- CR_COMMA, CR_WORD
+ CR_UNKNOWN, /**< Unknown token type. */
+ CR_END, /**< End of input ('\\0' or ':'). */
+ CR_AND, /**< Logical and operator (&&). */
+ CR_OR, /**< Logical or operator (||). */
+ CR_NOT, /**< Logical not operator (!). */
+ CR_OPENPAREN, /**< Open parenthesis. */
+ CR_CLOSEPAREN, /**< Close parenthesis. */
+ CR_COMMA, /**< Comma. */
+ CR_WORD /**< Something that looks like a hostmask (alphanumerics, "*?.-"). */
};
+/** Parser error codes. */
enum crule_errcode {
- CR_NOERR, CR_UNEXPCTTOK, CR_UNKNWTOK, CR_EXPCTAND, CR_EXPCTOR,
- CR_EXPCTPRIM, CR_EXPCTOPEN, CR_EXPCTCLOSE, CR_UNKNWFUNC, CR_ARGMISMAT
+ CR_NOERR, /**< No error. */
+ CR_UNEXPCTTOK, /**< Invalid token given context. */
+ CR_UNKNWTOK, /**< Input did not form a valid token. */
+ CR_EXPCTAND, /**< Did not see expected && operator. */
+ CR_EXPCTOR, /**< Did not see expected || operator. */
+ CR_EXPCTPRIM, /**< Expected a primitive (parentheses, ! or word). */
+ CR_EXPCTOPEN, /**< Expected an open parenthesis after function name. */
+ CR_EXPCTCLOSE, /**< Expected a close parenthesis to match open parenthesis. */
+ CR_UNKNWFUNC, /**< Attempt to use an unknown function. */
+ CR_ARGMISMAT /**< Wrong number of arguments to function. */
};
/*
* Expression tree structure, function pointer, and tree pointer local!
*/
+/** Evaluation function for a connection rule. */
typedef int (*crule_funcptr) (int, void **);
-struct crule_treestruct {
- crule_funcptr funcptr;
- int numargs;
- void *arg[CR_MAXARGS]; /* For operators arg points to a tree element;
- for functions arg points to a char string. */
+/** Node in a connection rule tree. */
+struct CRuleNode {
+ crule_funcptr funcptr; /**< Evaluation function for this node. */
+ int numargs; /**< Number of arguments. */
+ void *arg[CR_MAXARGS]; /**< Array of arguments. For operators, each arg
+ is a tree element; for functions, each arg is
+ a string. */
};
-typedef struct crule_treestruct crule_treeelem;
-typedef crule_treeelem *crule_treeptr;
+/** Typedef to save typing effort. */
+typedef struct CRuleNode* CRuleNodePtr;
/* local rule function prototypes */
-static int crule_connected(int, void **);
-static int crule_directcon(int, void **);
-static int crule_via(int, void **);
-static int crule_directop(int, void **);
-static int crule__andor(int, void **);
-static int crule__not(int, void **);
+static int crule_connected(int, void *[]);
+static int crule_directcon(int, void *[]);
+static int crule_via(int, void *[]);
+static int crule_directop(int, void *[]);
+static int crule__andor(int, void *[]);
+static int crule__not(int, void *[]);
/* local parsing function prototypes */
-static int crule_gettoken(int *, char **);
-static void crule_getword(char *, int *, size_t, char **);
-static int crule_parseandexpr(crule_treeptr *, int *, char **);
-static int crule_parseorexpr(crule_treeptr *, int *, char **);
-static int crule_parseprimary(crule_treeptr *, int *, char **);
-static int crule_parsefunction(crule_treeptr *, int *, char **);
-static int crule_parsearglist(crule_treeptr, int *, char **);
+static int crule_gettoken(int* token, const char** str);
+static void crule_getword(char*, int*, size_t, const char**);
+static int crule_parseandexpr(CRuleNodePtr*, int *, const char**);
+static int crule_parseorexpr(CRuleNodePtr*, int *, const char**);
+static int crule_parseprimary(CRuleNodePtr*, int *, const char**);
+static int crule_parsefunction(CRuleNodePtr*, int *, const char**);
+static int crule_parsearglist(CRuleNodePtr, int *, const char**);
#if defined(CR_DEBUG) || defined(CR_CHKCONF)
/*
* Prototypes for the test parser; if not debugging,
* these are defined in h.h
*/
-char *crule_parse(char *);
-void crule_free(char **);
+struct CRuleNode* crule_parse(const char*);
+void crule_free(struct CRuleNode**);
#ifdef CR_DEBUG
-void print_tree(crule_treeptr);
+void print_tree(CRuleNodePtr);
#endif
#endif
-/* error messages */
+/** Error messages, indexed by the corresponding crule_errcode. */
char *crule_errstr[] = {
- "Unknown error", /* NOERR? - for completeness */
- "Unexpected token", /* UNEXPCTTOK */
- "Unknown token", /* UNKNWTOK */
- "And expr expected", /* EXPCTAND */
- "Or expr expected", /* EXPCTOR */
- "Primary expected", /* EXPCTPRIM */
- "( expected", /* EXPCTOPEN */
- ") expected", /* EXPCTCLOSE */
- "Unknown function", /* UNKNWFUNC */
- "Argument mismatch" /* ARGMISMAT */
+ "Unknown error", /* NOERR? - for completeness */
+ "Unexpected token", /* UNEXPCTTOK */
+ "Unknown token", /* UNKNWTOK */
+ "And expr expected", /* EXPCTAND */
+ "Or expr expected", /* EXPCTOR */
+ "Primary expected", /* EXPCTPRIM */
+ "( expected", /* EXPCTOPEN */
+ ") expected", /* EXPCTCLOSE */
+ "Unknown function", /* UNKNWFUNC */
+ "Argument mismatch" /* ARGMISMAT */
};
-/* function table - null terminated */
+/** Connection rule function table entry. */
struct crule_funclistent {
- char name[15]; /* MAXIMUM FUNCTION NAME LENGTH IS 14 CHARS!! */
- int reqnumargs;
- crule_funcptr funcptr;
+ char name[15]; /**< Function name. */
+ int reqnumargs; /**< Required number of arguments. */
+ crule_funcptr funcptr; /**< Handler function. */
};
+/** Defined connection rules. */
struct crule_funclistent crule_funclist[] = {
/* maximum function name length is 14 chars */
{"connected", 1, crule_connected},
{"directcon", 1, crule_directcon},
{"via", 2, crule_via},
{"directop", 0, crule_directop},
- {"", 0, NULL} /* this must be here to mark end of list */
+ {"", 0, NULL} /* this must be here to mark end of list */
};
-#if !defined(CR_DEBUG) && !defined(CR_CHKCONF)
-static int crule_connected(int UNUSED(numargs), void *crulearg[])
+/** Check whether any connected server matches crulearg[0].
+ * @param[in] numargs Number of valid args in \a crulearg.
+ * @param[in] crulearg Argument array.
+ * @return Non-zero if the condition is true, zero if not.
+ */
+static int crule_connected(int numargs, void *crulearg[])
{
- aClient *acptr;
+#if !defined(CR_DEBUG) && !defined(CR_CHKCONF)
+ struct Client *acptr;
/* taken from m_links */
- for (acptr = client; acptr; acptr = acptr->next)
+ for (acptr = GlobalClientList; acptr; acptr = cli_next(acptr))
{
if (!IsServer(acptr) && !IsMe(acptr))
continue;
- if (match((char *)crulearg[0], acptr->name))
+ if (match((char *)crulearg[0], cli_name(acptr)))
continue;
return (1);
}
+#endif
return (0);
}
-#else
-static int crule_connected(int UNUSED(numargs), void **UNUSED(crulearg))
-{
- return (0);
-}
-#endif
-#if !defined(CR_DEBUG) && !defined(CR_CHKCONF)
-static int crule_directcon(int UNUSED(numargs), void *crulearg[])
+/** Check whether any directly connected server matches crulearg[0].
+ * @param[in] numargs Number of valid args in \a crulearg.
+ * @param[in] crulearg Argument array.
+ * @return Non-zero if the condition is true, zero if not.
+ */
+static int crule_directcon(int numargs, void *crulearg[])
{
+#if !defined(CR_DEBUG) && !defined(CR_CHKCONF)
int i;
- aClient *acptr;
+ struct Client *acptr;
/* adapted from m_trace and exit_one_client */
- for (i = 0; i <= highest_fd; i++)
+ for (i = 0; i <= HighestFd; i++)
{
- if (!(acptr = loc_clients[i]) || !IsServer(acptr))
+ if (!(acptr = LocalClientArray[i]) || !IsServer(acptr))
continue;
- if (match((char *)crulearg[0], acptr->name))
+ if (match((char *)crulearg[0], cli_name(acptr)))
continue;
return (1);
}
+#endif
return (0);
}
-#else
-static int crule_directcon(int UNUSED(numargs), void **UNUSED(crulearg))
-{
- return (0);
-}
-#endif
-#if !defined(CR_DEBUG) && !defined(CR_CHKCONF)
-static int crule_via(int UNUSED(numargs), void *crulearg[])
+/** Check whether a connected server matching crulearg[1] is
+ * connnected to me behind one matching crulearg[0].
+ * @param[in] numargs Number of valid args in \a crulearg.
+ * @param[in] crulearg Argument array.
+ * @return Non-zero if the condition is true, zero if not.
+ */
+static int crule_via(int numargs, void *crulearg[])
{
- aClient *acptr;
+#if !defined(CR_DEBUG) && !defined(CR_CHKCONF)
+ struct Client *acptr;
/* adapted from m_links */
- for (acptr = client; acptr; acptr = acptr->next)
+ for (acptr = GlobalClientList; acptr; acptr = cli_next(acptr))
{
if (!IsServer(acptr) && !IsMe(acptr))
continue;
- if (match((char *)crulearg[1], acptr->name))
+ if (match((char *)crulearg[1], cli_name(acptr)))
continue;
- if (match((char *)crulearg[0], (loc_clients[acptr->from->fd])->name))
+ if (match((char *)crulearg[0], cli_name(cli_from(acptr))))
continue;
return (1);
}
+#endif
return (0);
}
-#else
-static int crule_via(int UNUSED(numargs), void **UNUSED(crulearg))
-{
- return (0);
-}
-#endif
-static int crule_directop(int UNUSED(numargs), void **UNUSED(crulearg))
+/** Check whether we have a local IRC operator.
+ * @param[in] numargs Number of valid args in \a crulearg.
+ * @param[in] crulearg Argument array.
+ * @return Non-zero if the condition is true, zero if not.
+ */
+static int crule_directop(int numargs, void *crulearg[])
{
#if !defined(CR_DEBUG) && !defined(CR_CHKCONF)
int i;
- aClient *acptr;
+ struct Client *acptr;
/* adapted from m_trace */
- for (i = 0; i <= highest_fd; i++)
+ for (i = 0; i <= HighestFd; i++)
{
- if (!(acptr = loc_clients[i]) || !IsAnOper(acptr))
+ if (!(acptr = LocalClientArray[i]) || !IsAnOper(acptr))
continue;
return (1);
}
return (0);
}
-static int crule__andor(int UNUSED(numargs), void *crulearg[])
+/** Evaluate a connection rule.
+ * @param[in] rule Rule to evalute.
+ * @return Non-zero if the rule allows the connection, zero otherwise.
+ */
+int crule_eval(struct CRuleNode* rule)
{
- int result1;
-
- result1 = ((crule_treeptr) crulearg[0])->funcptr
- (((crule_treeptr) crulearg[0])->numargs,
- ((crule_treeptr) crulearg[0])->arg);
- if (crulearg[2]) /* or */
- return (result1 ||
- ((crule_treeptr) crulearg[1])->funcptr
- (((crule_treeptr) crulearg[1])->numargs,
- ((crule_treeptr) crulearg[1])->arg));
- else
- return (result1 &&
- ((crule_treeptr) crulearg[1])->funcptr
- (((crule_treeptr) crulearg[1])->numargs,
- ((crule_treeptr) crulearg[1])->arg));
+ return (rule->funcptr(rule->numargs, rule->arg));
}
-static int crule__not(int UNUSED(numargs), void *crulearg[])
+/** Perform an and-or-or test on crulearg[0] and crulearg[1].
+ * If crulearg[2] is non-NULL, it means do OR; if it is NULL, do AND.
+ * @param[in] numargs Number of valid args in \a crulearg.
+ * @param[in] crulearg Argument array.
+ * @return Non-zero if the condition is true, zero if not.
+ */
+static int crule__andor(int numargs, void *crulearg[])
{
- return (!((crule_treeptr) crulearg[0])->funcptr
- (((crule_treeptr) crulearg[0])->numargs,
- ((crule_treeptr) crulearg[0])->arg));
+ int result1;
+
+ result1 = crule_eval(crulearg[0]);
+ if (crulearg[2]) /* or */
+ return (result1 || crule_eval(crulearg[1]));
+ else
+ return (result1 && crule_eval(crulearg[1]));
}
-#if !defined(CR_DEBUG) && !defined(CR_CHKCONF)
-int crule_eval(char *rule)
+/** Logically invert the result of crulearg[0].
+ * @param[in] numargs Number of valid args in \a crulearg.
+ * @param[in] crulearg Argument array.
+ * @return Non-zero if the condition is true, zero if not.
+ */
+static int crule__not(int numargs, void *crulearg[])
{
- return (((crule_treeptr) rule)->funcptr
- (((crule_treeptr) rule)->numargs, ((crule_treeptr) rule)->arg));
+ return (!crule_eval(crulearg[0]));
}
-#endif
-static int crule_gettoken(int *next_tokp, char **ruleptr)
+/** Scan an input token from \a ruleptr.
+ * @param[out] next_tokp Receives type of next token.
+ * @param[in,out] ruleptr Next readable character from input.
+ * @return Either CR_UNKNWTOK if the input was unrecognizable, else CR_NOERR.
+ */
+static int crule_gettoken(int* next_tokp, const char** ruleptr)
{
char pending = '\0';
{
case ' ':
case '\t':
- break;
+ break;
case '&':
- if (pending == '\0')
- pending = '&';
- else if (pending == '&')
- *next_tokp = CR_AND;
- else
- return (CR_UNKNWTOK);
- break;
+ if (pending == '\0')
+ pending = '&';
+ else if (pending == '&')
+ *next_tokp = CR_AND;
+ else
+ return (CR_UNKNWTOK);
+ break;
case '|':
- if (pending == '\0')
- pending = '|';
- else if (pending == '|')
- *next_tokp = CR_OR;
- else
- return (CR_UNKNWTOK);
- break;
+ if (pending == '\0')
+ pending = '|';
+ else if (pending == '|')
+ *next_tokp = CR_OR;
+ else
+ return (CR_UNKNWTOK);
+ break;
case '!':
- *next_tokp = CR_NOT;
- break;
+ *next_tokp = CR_NOT;
+ break;
case '(':
- *next_tokp = CR_OPENPAREN;
- break;
+ *next_tokp = CR_OPENPAREN;
+ break;
case ')':
- *next_tokp = CR_CLOSEPAREN;
- break;
+ *next_tokp = CR_CLOSEPAREN;
+ break;
case ',':
- *next_tokp = CR_COMMA;
- break;
+ *next_tokp = CR_COMMA;
+ break;
case '\0':
- (*ruleptr)--;
- *next_tokp = CR_END;
- break;
+ (*ruleptr)--;
+ *next_tokp = CR_END;
+ break;
case ':':
- *next_tokp = CR_END;
- break;
+ *next_tokp = CR_END;
+ break;
default:
- if ((isAlpha(*(--(*ruleptr)))) || (**ruleptr == '*') ||
- (**ruleptr == '?') || (**ruleptr == '.') || (**ruleptr == '-'))
- *next_tokp = CR_WORD;
- else
- return (CR_UNKNWTOK);
- break;
+ if ((IsAlpha(*(--(*ruleptr)))) || (**ruleptr == '*') ||
+ (**ruleptr == '?') || (**ruleptr == '.') || (**ruleptr == '-'))
+ *next_tokp = CR_WORD;
+ else
+ return (CR_UNKNWTOK);
+ break;
}
return CR_NOERR;
}
-static void crule_getword(char *word, int *wordlenp, size_t maxlen,
- char **ruleptr)
+/** Scan a word from \a ruleptr.
+ * @param[out] word Output buffer.
+ * @param[out] wordlenp Length of word written to \a word (not including terminating NUL).
+ * @param[in] maxlen Maximum number of bytes writable to \a word.
+ * @param[in,out] ruleptr Next readable character from input.
+ */
+static void crule_getword(char* word, int* wordlenp, size_t maxlen, const char** ruleptr)
{
char *word_ptr;
word_ptr = word;
while ((size_t)(word_ptr - word) < maxlen
- && (isAlnum(**ruleptr)
+ && (IsAlnum(**ruleptr)
|| **ruleptr == '*' || **ruleptr == '?'
|| **ruleptr == '.' || **ruleptr == '-'))
*word_ptr++ = *(*ruleptr)++;
*wordlenp = word_ptr - word;
}
-/*
- * Grammar
- * rule:
- * orexpr END END is end of input or :
- * orexpr:
- * andexpr
- * andexpr || orexpr
- * andexpr:
- * primary
- * primary && andexpr
- * primary:
- * function
- * ! primary
- * ( orexpr )
- * function:
- * word ( ) word is alphanumeric string, first character
- * word ( arglist ) must be a letter
- * arglist:
- * word
- * word , arglist
+/** Parse an entire rule.
+ * @param[in] rule Text form of rule.
+ * @return CRuleNode for rule, or NULL if there was a parse error.
*/
-char *crule_parse(char *rule)
+struct CRuleNode* crule_parse(const char *rule)
{
- char *ruleptr = rule;
+ const char* ruleptr = rule;
int next_tok;
- crule_treeptr ruleroot = NULL;
+ struct CRuleNode* ruleroot = 0;
int errcode = CR_NOERR;
- if ((errcode = crule_gettoken(&next_tok, &ruleptr)) == CR_NOERR)
- {
- if ((errcode = crule_parseorexpr(&ruleroot, &next_tok, &ruleptr))
- == CR_NOERR)
- {
- if (ruleroot != NULL)
- {
- if (next_tok == CR_END)
- return ((char *)ruleroot);
- else
- errcode = CR_UNEXPCTTOK;
+ if ((errcode = crule_gettoken(&next_tok, &ruleptr)) == CR_NOERR) {
+ if ((errcode = crule_parseorexpr(&ruleroot, &next_tok, &ruleptr)) == CR_NOERR) {
+ if (ruleroot != NULL) {
+ if (next_tok == CR_END)
+ return (ruleroot);
+ else
+ errcode = CR_UNEXPCTTOK;
}
else
- errcode = CR_EXPCTOR;
+ errcode = CR_EXPCTOR;
}
}
if (ruleroot != NULL)
- crule_free((char **)&ruleroot);
+ crule_free(&ruleroot);
#if !defined(CR_DEBUG) && !defined(CR_CHKCONF)
Debug((DEBUG_ERROR, "%s in rule: %s", crule_errstr[errcode], rule));
#else
fprintf(stderr, "%s in rule: %s\n", crule_errstr[errcode], rule);
#endif
- return NULL;
+ return 0;
}
-static int crule_parseorexpr(crule_treeptr * orrootp, int *next_tokp,
- char **ruleptr)
+/** Parse an or expression.
+ * @param[out] orrootp Receives parsed node.
+ * @param[in,out] next_tokp Next input token type.
+ * @param[in,out] ruleptr Next input character.
+ * @return A crule_errcode value.
+ */
+static int crule_parseorexpr(CRuleNodePtr * orrootp, int *next_tokp, const char** ruleptr)
{
int errcode = CR_NOERR;
- crule_treeptr andexpr;
- crule_treeptr orptr;
+ CRuleNodePtr andexpr;
+ CRuleNodePtr orptr;
*orrootp = NULL;
while (errcode == CR_NOERR)
errcode = crule_parseandexpr(&andexpr, next_tokp, ruleptr);
if ((errcode == CR_NOERR) && (*next_tokp == CR_OR))
{
- orptr = (crule_treeptr) RunMalloc(sizeof(crule_treeelem));
+ orptr = (CRuleNodePtr) MyMalloc(sizeof(struct CRuleNode));
#ifdef CR_DEBUG
fprintf(stderr, "allocating or element at %ld\n", orptr);
#endif
orptr->arg[2] = (void *)1;
if (*orrootp != NULL)
{
- (*orrootp)->arg[1] = andexpr;
- orptr->arg[0] = *orrootp;
+ (*orrootp)->arg[1] = andexpr;
+ orptr->arg[0] = *orrootp;
}
else
- orptr->arg[0] = andexpr;
+ orptr->arg[0] = andexpr;
*orrootp = orptr;
}
else
{
if (*orrootp != NULL)
{
- if (andexpr != NULL)
- {
- (*orrootp)->arg[1] = andexpr;
- return (errcode);
- }
- else
- {
- (*orrootp)->arg[1] = NULL; /* so free doesn't seg fault */
- return (CR_EXPCTAND);
- }
+ if (andexpr != NULL)
+ {
+ (*orrootp)->arg[1] = andexpr;
+ return (errcode);
+ }
+ else
+ {
+ (*orrootp)->arg[1] = NULL; /* so free doesn't seg fault */
+ return (CR_EXPCTAND);
+ }
}
else
{
- *orrootp = andexpr;
- return (errcode);
+ *orrootp = andexpr;
+ return (errcode);
}
}
if ((errcode = crule_gettoken(next_tokp, ruleptr)) != CR_NOERR)
return (errcode);
}
-static int crule_parseandexpr(crule_treeptr * androotp, int *next_tokp,
- char **ruleptr)
+/** Parse an and expression.
+ * @param[out] androotp Receives parsed node.
+ * @param[in,out] next_tokp Next input token type.
+ * @param[in,out] ruleptr Next input character.
+ * @return A crule_errcode value.
+ */
+static int crule_parseandexpr(CRuleNodePtr * androotp, int *next_tokp, const char** ruleptr)
{
int errcode = CR_NOERR;
- crule_treeptr primary;
- crule_treeptr andptr;
+ CRuleNodePtr primary;
+ CRuleNodePtr andptr;
*androotp = NULL;
while (errcode == CR_NOERR)
errcode = crule_parseprimary(&primary, next_tokp, ruleptr);
if ((errcode == CR_NOERR) && (*next_tokp == CR_AND))
{
- andptr = (crule_treeptr) RunMalloc(sizeof(crule_treeelem));
+ andptr = (CRuleNodePtr) MyMalloc(sizeof(struct CRuleNode));
#ifdef CR_DEBUG
fprintf(stderr, "allocating and element at %ld\n", andptr);
#endif
andptr->arg[2] = (void *)0;
if (*androotp != NULL)
{
- (*androotp)->arg[1] = primary;
- andptr->arg[0] = *androotp;
+ (*androotp)->arg[1] = primary;
+ andptr->arg[0] = *androotp;
}
else
- andptr->arg[0] = primary;
+ andptr->arg[0] = primary;
*androotp = andptr;
}
else
{
if (*androotp != NULL)
{
- if (primary != NULL)
- {
- (*androotp)->arg[1] = primary;
- return (errcode);
- }
- else
- {
- (*androotp)->arg[1] = NULL; /* so free doesn't seg fault */
- return (CR_EXPCTPRIM);
- }
+ if (primary != NULL)
+ {
+ (*androotp)->arg[1] = primary;
+ return (errcode);
+ }
+ else
+ {
+ (*androotp)->arg[1] = NULL; /* so free doesn't seg fault */
+ return (CR_EXPCTPRIM);
+ }
}
else
{
- *androotp = primary;
- return (errcode);
+ *androotp = primary;
+ return (errcode);
}
}
if ((errcode = crule_gettoken(next_tokp, ruleptr)) != CR_NOERR)
return (errcode);
}
-static int crule_parseprimary(crule_treeptr * primrootp,
- int *next_tokp, char **ruleptr)
+/** Parse a primary expression.
+ * @param[out] primrootp Receives parsed node.
+ * @param[in,out] next_tokp Next input token type.
+ * @param[in,out] ruleptr Next input character.
+ * @return A crule_errcode value.
+ */
+static int crule_parseprimary(CRuleNodePtr* primrootp, int *next_tokp, const char** ruleptr)
{
- crule_treeptr *insertionp;
+ CRuleNodePtr *insertionp;
int errcode = CR_NOERR;
*primrootp = NULL;
switch (*next_tokp)
{
case CR_OPENPAREN:
- if ((errcode = crule_gettoken(next_tokp, ruleptr)) != CR_NOERR)
- break;
- if ((errcode = crule_parseorexpr(insertionp, next_tokp,
- ruleptr)) != CR_NOERR)
- break;
- if (*insertionp == NULL)
- {
- errcode = CR_EXPCTAND;
- break;
- }
- if (*next_tokp != CR_CLOSEPAREN)
- {
- errcode = CR_EXPCTCLOSE;
- break;
- }
- errcode = crule_gettoken(next_tokp, ruleptr);
- break;
+ if ((errcode = crule_gettoken(next_tokp, ruleptr)) != CR_NOERR)
+ break;
+ if ((errcode = crule_parseorexpr(insertionp, next_tokp, ruleptr)) != CR_NOERR)
+ break;
+ if (*insertionp == NULL)
+ {
+ errcode = CR_EXPCTAND;
+ break;
+ }
+ if (*next_tokp != CR_CLOSEPAREN)
+ {
+ errcode = CR_EXPCTCLOSE;
+ break;
+ }
+ errcode = crule_gettoken(next_tokp, ruleptr);
+ break;
case CR_NOT:
- *insertionp = (crule_treeptr) RunMalloc(sizeof(crule_treeelem));
+ *insertionp = (CRuleNodePtr) MyMalloc(sizeof(struct CRuleNode));
#ifdef CR_DEBUG
- fprintf(stderr, "allocating primary element at %ld\n", *insertionp);
+ fprintf(stderr, "allocating primary element at %ld\n", *insertionp);
#endif
- (*insertionp)->funcptr = crule__not;
- (*insertionp)->numargs = 1;
- (*insertionp)->arg[0] = NULL;
- insertionp = (crule_treeptr *) & ((*insertionp)->arg[0]);
- if ((errcode = crule_gettoken(next_tokp, ruleptr)) != CR_NOERR)
- break;
- continue;
+ (*insertionp)->funcptr = crule__not;
+ (*insertionp)->numargs = 1;
+ (*insertionp)->arg[0] = NULL;
+ insertionp = (CRuleNodePtr *) & ((*insertionp)->arg[0]);
+ if ((errcode = crule_gettoken(next_tokp, ruleptr)) != CR_NOERR)
+ break;
+ continue;
case CR_WORD:
- errcode = crule_parsefunction(insertionp, next_tokp, ruleptr);
- break;
+ errcode = crule_parsefunction(insertionp, next_tokp, ruleptr);
+ break;
default:
- if (*primrootp == NULL)
- errcode = CR_NOERR;
- else
- errcode = CR_EXPCTPRIM;
- break;
+ if (*primrootp == NULL)
+ errcode = CR_NOERR;
+ else
+ errcode = CR_EXPCTPRIM;
+ break;
}
return (errcode);
}
return (errcode);
}
-static int crule_parsefunction(crule_treeptr * funcrootp,
- int *next_tokp, char **ruleptr)
+/** Parse a function call.
+ * @param[out] funcrootp Receives parsed node.
+ * @param[in,out] next_tokp Next input token type.
+ * @param[in,out] ruleptr Next input character.
+ * @return A crule_errcode value.
+ */
+static int crule_parsefunction(CRuleNodePtr* funcrootp, int* next_tokp, const char** ruleptr)
{
int errcode = CR_NOERR;
char funcname[CR_MAXARGLEN];
{
for (funcnum = 0;; funcnum++)
{
- if (strCasediff(crule_funclist[funcnum].name, funcname) == 0)
- break;
+ if (0 == ircd_strcmp(crule_funclist[funcnum].name, funcname))
+ break;
if (crule_funclist[funcnum].name[0] == '\0')
- return (CR_UNKNWFUNC);
+ return (CR_UNKNWFUNC);
}
if ((errcode = crule_gettoken(next_tokp, ruleptr)) != CR_NOERR)
return (errcode);
- *funcrootp = (crule_treeptr) RunMalloc(sizeof(crule_treeelem));
+ *funcrootp = (CRuleNodePtr) MyMalloc(sizeof(struct CRuleNode));
#ifdef CR_DEBUG
fprintf(stderr, "allocating function element at %ld\n", *funcrootp);
#endif
- (*funcrootp)->funcptr = NULL; /* for freeing aborted trees */
+ (*funcrootp)->funcptr = NULL; /* for freeing aborted trees */
if ((errcode =
- crule_parsearglist(*funcrootp, next_tokp, ruleptr)) != CR_NOERR)
+ crule_parsearglist(*funcrootp, next_tokp, ruleptr)) != CR_NOERR)
return (errcode);
if (*next_tokp != CR_CLOSEPAREN)
return (CR_EXPCTCLOSE);
if ((crule_funclist[funcnum].reqnumargs != (*funcrootp)->numargs) &&
- (crule_funclist[funcnum].reqnumargs != -1))
+ (crule_funclist[funcnum].reqnumargs != -1))
return (CR_ARGMISMAT);
if ((errcode = crule_gettoken(next_tokp, ruleptr)) != CR_NOERR)
return (errcode);
return (CR_EXPCTOPEN);
}
-static int crule_parsearglist(crule_treeptr argrootp, int *next_tokp,
- char **ruleptr)
+/** Parse the argument list to a CRuleNode.
+ * @param[in,out] argrootp Node whos argument list is being populated.
+ * @param[in,out] next_tokp Next input token type.
+ * @param[in,out] ruleptr Next input character.
+ * @return A crule_errcode value.
+ */
+static int crule_parsearglist(CRuleNodePtr argrootp, int *next_tokp, const char** ruleptr)
{
int errcode = CR_NOERR;
char *argelemp = NULL;
switch (*next_tokp)
{
case CR_WORD:
- crule_getword(word, &wordlen, CR_MAXARGLEN - 1, ruleptr);
- if (currarg[0] != '\0')
- {
- if ((arglen + wordlen) < (CR_MAXARGLEN - 1))
- {
- strcat(currarg, " ");
- strcat(currarg, word);
- arglen += wordlen + 1;
- }
- }
- else
- {
- strcpy(currarg, word);
- arglen = wordlen;
- }
- errcode = crule_gettoken(next_tokp, ruleptr);
- break;
+ crule_getword(word, &wordlen, CR_MAXARGLEN - 1, ruleptr);
+ if (currarg[0] != '\0')
+ {
+ if ((arglen + wordlen) < (CR_MAXARGLEN - 1))
+ {
+ strcat(currarg, " ");
+ strcat(currarg, word);
+ arglen += wordlen + 1;
+ }
+ }
+ else
+ {
+ strcpy(currarg, word);
+ arglen = wordlen;
+ }
+ errcode = crule_gettoken(next_tokp, ruleptr);
+ break;
default:
#if !defined(CR_DEBUG) && !defined(CR_CHKCONF)
- collapse(currarg);
+ collapse(currarg);
#endif
- if (!BadPtr(currarg))
- {
- DupString(argelemp, currarg);
- argrootp->arg[argrootp->numargs++] = (void *)argelemp;
- }
- if (*next_tokp != CR_COMMA)
- return (CR_NOERR);
- currarg[0] = '\0';
- errcode = crule_gettoken(next_tokp, ruleptr);
- break;
+ if (!BadPtr(currarg))
+ {
+ DupString(argelemp, currarg);
+ argrootp->arg[argrootp->numargs++] = (void *)argelemp;
+ }
+ if (*next_tokp != CR_COMMA)
+ return (CR_NOERR);
+ currarg[0] = '\0';
+ errcode = crule_gettoken(next_tokp, ruleptr);
+ break;
}
}
return (errcode);
/*
* This function is recursive.. I wish I knew a nonrecursive way but
- * I dont. anyway, recursion is fun.. :)
- * DO NOT CALL THIS FUNTION WITH A POINTER TO A NULL POINTER
- * (ie: If *elem is NULL, you're doing it wrong - seg fault)
+ * I don't. Anyway, recursion is fun.. :)
+ * DO NOT CALL THIS FUNCTION WITH A POINTER TO A NULL POINTER
+ * (i.e.: If *elem is NULL, you're doing it wrong - seg fault)
*/
-void crule_free(char **elem)
+/** Free a connection rule and all its children.
+ * @param[in,out] elem Pointer to pointer to element to free. MUST NOT BE NULL.
+ */
+void crule_free(struct CRuleNode** elem)
{
int arg, numargs;
- if ((*((crule_treeptr *) elem))->funcptr == crule__not)
+ if ((*(elem))->funcptr == crule__not)
{
- /* type conversions and ()'s are fun! ;) here have an asprin.. */
- if ((*((crule_treeptr *) elem))->arg[0] != NULL)
- crule_free((char **)&((*((crule_treeptr *) elem))->arg[0]));
+ /* type conversions and ()'s are fun! ;) here have an aspirin.. */
+ if ((*(elem))->arg[0] != NULL)
+ crule_free((struct CRuleNode**) &((*(elem))->arg[0]));
}
- else if ((*((crule_treeptr *) elem))->funcptr == crule__andor)
+ else if ((*(elem))->funcptr == crule__andor)
{
- crule_free((char **)&((*((crule_treeptr *) elem))->arg[0]));
- if ((*((crule_treeptr *) elem))->arg[1] != NULL)
- crule_free((char **)&((*((crule_treeptr *) elem))->arg[1]));
+ crule_free((struct CRuleNode**) &((*(elem))->arg[0]));
+ if ((*(elem))->arg[1] != NULL)
+ crule_free((struct CRuleNode**) &((*(elem))->arg[1]));
}
else
{
- numargs = (*((crule_treeptr *) elem))->numargs;
+ numargs = (*(elem))->numargs;
for (arg = 0; arg < numargs; arg++)
- RunFree((char *)(*((crule_treeptr *) elem))->arg[arg]);
+ MyFree((*(elem))->arg[arg]);
}
#ifdef CR_DEBUG
fprintf(stderr, "freeing element at %ld\n", *elem);
#endif
- RunFree(*elem);
- *elem = NULL;
+ MyFree(*elem);
+ *elem = 0;
}
#ifdef CR_DEBUG
-static void print_tree(crule_treeptr printelem)
+/** Display a connection rule as text.
+ * @param[in] printelem Connection rule to display.
+ */
+static void print_tree(CRuleNodePtr printelem)
{
int funcnum, arg;
if (printelem->funcptr == crule__not)
{
printf("!( ");
- print_tree((crule_treeptr) printelem->arg[0]);
+ print_tree((CRuleNodePtr) printelem->arg[0]);
printf(") ");
}
else if (printelem->funcptr == crule__andor)
{
printf("( ");
- print_tree((crule_treeptr) printelem->arg[0]);
+ print_tree((CRuleNodePtr) printelem->arg[0]);
if (printelem->arg[2])
printf("|| ");
else
printf("&& ");
- print_tree((crule_treeptr) printelem->arg[1]);
+ print_tree((CRuleNodePtr) printelem->arg[1]);
printf(") ");
}
else
for (funcnum = 0;; funcnum++)
{
if (printelem->funcptr == crule_funclist[funcnum].funcptr)
- break;
+ break;
if (crule_funclist[funcnum].funcptr == NULL)
- MyCoreDump;
+ MyCoreDump;
}
printf("%s(", crule_funclist[funcnum].name);
for (arg = 0; arg < printelem->numargs; arg++)
{
if (arg != 0)
- printf(",");
+ printf(",");
printf("%s", (char *)printelem->arg[arg]);
}
printf(") ");
#endif
#ifdef CR_DEBUG
+/** Read connection rules from stdin and display parsed forms as text.
+ * @return Zero.
+ */
int main(void)
{
char indata[256];
- char *rule;
+ CRuleNode* rule;
printf("rule: ");
while (fgets(indata, 256, stdin) != NULL)
{
- indata[strlen(indata) - 1] = '\0'; /* lose the newline */
+ indata[strlen(indata) - 1] = '\0'; /* lose the newline */
if ((rule = crule_parse(indata)) != NULL)
{
printf("equivalent rule: ");
- print_tree((crule_treeptr) rule);
+ print_tree((CRuleNodePtr) rule);
printf("\n");
crule_free(&rule);
}