first shot at scoping (for actions only)

parser now supports $Begin action, $End action, $StrictScoping,
but not yet the actual semantics.

6 files changed, 140 insertions, 43 deletions

diff --git a/runtime/cfsysline.c b/runtime/cfsysline.c
index 041b5b28..1743b818 100644
--- a/runtime/cfsysline.c
+++ b/runtime/cfsysline.c
@@ -39,6 +39,7 @@
 
 #include "cfsysline.h"
 #include "obj.h"
+#include "conf.h"
 #include "errmsg.h"
 #include "srUtils.h"
 
@@ -912,6 +913,7 @@ rsRetVal processCfSysLineCommand(uchar *pCmdName, uchar **p)
 	uchar *pHdlrP; /* the handler's private p (else we could only call one handler) */
 	int bWasOnceOK; /* was the result of an handler at least once RS_RET_OK? */
 	uchar *pOKp = NULL; /* returned conf line pointer when it was OK */
+	int bHadScopingErr = 0; /* set if a scoping error occured */
 
 	iRet = llFind(&llCmdList, (void *) pCmdName, (void*) &pCmd);
 
@@ -925,17 +927,25 @@ rsRetVal processCfSysLineCommand(uchar *pCmdName, uchar **p)
 	llCookieCmdHdlr = NULL;
 	bWasOnceOK = 0;
 	while((iRetLL = llGetNextElt(&pCmd->llCmdHdlrs, &llCookieCmdHdlr, (void*)&pCmdHdlr)) == RS_RET_OK) {
-		/* for the time being, we ignore errors during handlers. The
-		 * reason is that handlers are independent. An error in one
-		 * handler does not necessarily mean that another one will
-		 * fail, too. Later, we might add a config variable to control
-		 * this behaviour (but I am not sure if that is rally
-		 * necessary). -- rgerhards, 2007-07-31
-		 */
-		pHdlrP = *p;
-		if((iRet = cslchCallHdlr(pCmdHdlr, &pHdlrP)) == RS_RET_OK) {
-			bWasOnceOK = 1;
-			pOKp = pHdlrP;
+		/* check if handler is valid in current scope */
+		if(pCmdHdlr->eConfObjType == eConfObjAlways ||
+		   (bConfStrictScoping == 0 && currConfObj == eConfObjGlobal) ||
+		   pCmdHdlr->eConfObjType == currConfObj) {
+			/* for the time being, we ignore errors during handlers. The
+			 * reason is that handlers are independent. An error in one
+			 * handler does not necessarily mean that another one will
+			 * fail, too. Later, we might add a config variable to control
+			 * this behaviour (but I am not sure if that is really
+			 * necessary). -- rgerhards, 2007-07-31
+			 */
+			pHdlrP = *p;
+			if((iRet = cslchCallHdlr(pCmdHdlr, &pHdlrP)) == RS_RET_OK) {
+				bWasOnceOK = 1;
+				pOKp = pHdlrP;
+			}
+		} else {
+			errmsg.LogError(0, RS_RET_CONF_INVLD_SCOPE, "config command invalid for current scope");
+			bHadScopingErr = 1;
 		}
 	}
 
@@ -947,6 +957,10 @@ rsRetVal processCfSysLineCommand(uchar *pCmdName, uchar **p)
 	if(iRetLL != RS_RET_END_OF_LINKEDLIST)
 		iRet = iRetLL;
 
+	if(bHadScopingErr) {
+		iRet = RS_RET_CONF_INVLD_SCOPE;
+	}
+
 finalize_it:
 	RETiRet;
 }
diff --git a/runtime/cfsysline.h b/runtime/cfsysline.h
index 81107aa3..a4502672 100644
--- a/runtime/cfsysline.h
+++ b/runtime/cfsysline.h
@@ -26,33 +26,6 @@
 
 #include "linkedlist.h"
 
-#if 0
-/* types of configuration handlers
- */
-enum cslCmdHdlrType {
-	eCmdHdlrInvalid = 0,		/* invalid handler type - indicates a coding error */
-	eCmdHdlrCustomHandler,		/* custom handler, just call handler function */
-	eCmdHdlrUID,
-	eCmdHdlrGID,
-	eCmdHdlrBinary,
-	eCmdHdlrFileCreateMode,
-	eCmdHdlrInt,
-	eCmdHdlrSize,
-	eCmdHdlrGetChar,
-	eCmdHdlrFacility,
-	eCmdHdlrSeverity,
-	eCmdHdlrGetWord
-};
-
-
-/* the next type describes $Begin .. $End block object types
- */
-enum cslConfObjType {
-	eConfObjGlobal = 0,	/* global directives */
-	eConfObjAction,		/* action-specific directives */
-};
-#endif
-
 /* this is a single entry for a parse routine. It describes exactly
  * one entry point/handler.
  * The short name is cslch (Configfile SysLine CommandHandler)
diff --git a/runtime/conf.c b/runtime/conf.c
index 96d9dcab..8106a2f5 100644
--- a/runtime/conf.c
+++ b/runtime/conf.c
@@ -52,7 +52,6 @@
 #endif
 
 #include "rsyslog.h"
-#include "../tools/syslogd.h" /* TODO: this must be removed! */
 #include "dirty.h"
 #include "parse.h"
 #include "action.h"
@@ -93,6 +92,10 @@ DEFobjCurrIf(net)
 DEFobjCurrIf(rule)
 DEFobjCurrIf(ruleset)
 
+ecslConfObjType currConfObj = eConfObjGlobal; /* to support scoping - which config object is currently active? */
+int bConfStrictScoping = 0;	/* force strict scoping during config processing? */
+
+
 static int iNbrActions = 0; /* number of currently defined actions */
 
 /* The following module-global variables are used for building
@@ -1097,6 +1100,11 @@ static rsRetVal cflineDoAction(uchar **p, action_t **ppAction)
 		iRet = pMod->mod.om.parseSelectorAct(p, &pModData, &pOMSR);
 		dbgprintf("tried selector action for %s: %d\n", module.GetName(pMod), iRet);
 		if(iRet == RS_RET_OK || iRet == RS_RET_SUSPENDED) {
+			/* advance our config parser state: we now only accept an $End as valid,
+			 * no more action statments.
+			 */
+			if(currConfObj == eConfObjAction)
+				currConfObj = eConfObjActionWaitEnd;
 			if((iRet = addAction(&pAction, pMod, pModData, pOMSR, (iRet == RS_RET_SUSPENDED)? 1 : 0)) == RS_RET_OK) {
 				/* now check if the module is compatible with select features */
 				if(pMod->isCompatibleWithFeature(sFEATURERepeatedMsgReduction) == RS_RET_OK)
@@ -1246,6 +1254,85 @@ finalize_it:
 ENDobjQueryInterface(conf)
 
 
+/* switch to a new action scope. This means that we switch the current 
+ * mode to action, but it also means we need to clear all scope variables,
+ * so that we have a new environment.
+ * rgerhards, 2010-07-23
+ */
+static inline rsRetVal
+setActionScope(void)
+{
+	DEFiRet;
+
+	currConfObj = eConfObjAction;
+	DBGPRINTF("entering action scope\n");
+
+	RETiRet;
+}
+
+
+/* This method is called by our own handlers to begin a new config
+ * object ($Begin statement). This also implies a new scope.
+ * rgerhards, 2010-07-23
+ */
+static rsRetVal
+beginConfObj(void __attribute__((unused)) *pVal, uchar *pszName)
+{
+	DEFiRet;
+
+	if(currConfObj != eConfObjGlobal) {
+		errmsg.LogError(0, RS_RET_CONF_NOT_GLBL, "not in global scope - can not nest $Begin");
+		ABORT_FINALIZE(RS_RET_CONF_NOT_GLBL);
+	}
+
+	if(!strcasecmp((char*)pszName, "action")) {
+		setActionScope();
+	} else {
+		errmsg.LogError(0, RS_RET_INVLD_CONF_OBJ, "invalid config object \"%s\" in $Begin", pszName);
+		ABORT_FINALIZE(RS_RET_INVLD_CONF_OBJ);
+	}
+
+finalize_it:
+	free(pszName); /* no longer needed */
+	RETiRet;
+}
+
+
+/* This method is called to end a config scope and switch
+ * back to global scope.
+ * rgerhards, 2010-07-23
+ */
+static rsRetVal
+endConfObj(void __attribute__((unused)) *pVal, uchar *pszName)
+{
+	DEFiRet;
+
+	if(currConfObj == eConfObjGlobal) {
+		errmsg.LogError(0, RS_RET_CONF_NOT_GLBL, "already in global scope - dangling $End");
+		ABORT_FINALIZE(RS_RET_CONF_IN_GLBL);
+	}
+
+	if(!strcasecmp((char*)pszName, "action")) {
+		if(currConfObj == eConfObjAction) {
+			errmsg.LogError(0, RS_RET_CONF_END_NO_ACT, "$End action but not action specified");
+			/* this is a warning, we continue processing in that case (unscope) */
+		} else if(currConfObj != eConfObjActionWaitEnd) {
+			errmsg.LogError(0, RS_RET_CONF_INVLD_END, "$End not for active config object - "
+							          "nesting error?");
+			ABORT_FINALIZE(RS_RET_CONF_INVLD_END);
+		}
+		currConfObj = eConfObjGlobal;
+	} else {
+		errmsg.LogError(0, RS_RET_INVLD_CONF_OBJ, "invalid config object \"%s\" in $End", pszName);
+		ABORT_FINALIZE(RS_RET_INVLD_CONF_OBJ);
+	}
+
+finalize_it:
+	free(pszName); /* no longer needed */
+	RETiRet;
+}
+
+
 /* exit our class
  * rgerhards, 2008-03-11
  */
@@ -1286,6 +1373,11 @@ BEGINAbstractObjClassInit(conf, 1, OBJ_IS_CORE_MODULE) /* class, version - CHANG
 	CHKiRet(objUse(net, LM_NET_FILENAME)); /* TODO: make this dependcy go away! */
 	CHKiRet(objUse(rule, CORE_COMPONENT));
 	CHKiRet(objUse(ruleset, CORE_COMPONENT));
+
+	CHKiRet(regCfSysLineHdlr((uchar *)"begin", 0, eCmdHdlrGetWord, beginConfObj, NULL, NULL, eConfObjGlobal));
+	CHKiRet(regCfSysLineHdlr((uchar *)"end", 0, eCmdHdlrGetWord, endConfObj, NULL, NULL, eConfObjAlways));
+	CHKiRet(regCfSysLineHdlr((uchar *)"strictscoping", 0, eCmdHdlrBinary, NULL, &bConfStrictScoping, NULL, eConfObjGlobal));
+#warning add $reset
 ENDObjClassInit(conf)
 
 /* vi:set ai:
diff --git a/runtime/conf.h b/runtime/conf.h
index d85d1f82..bc09d502 100644
--- a/runtime/conf.h
+++ b/runtime/conf.h
@@ -28,6 +28,8 @@
  * somewhat strange (at least its name). -- rgerhards, 2007-08-01
  */
 enum eDirective { DIR_TEMPLATE = 0, DIR_OUTCHANNEL = 1, DIR_ALLOWEDSENDER = 2};
+extern ecslConfObjType currConfObj;
+extern int bConfStrictScoping;	/* force strict scoping during config processing? */
 
 /* interfaces */
 BEGINinterface(conf) /* name must also be changed in ENDinterface macro! */
@@ -38,8 +40,14 @@ BEGINinterface(conf) /* name must also be changed in ENDinterface macro! */
 	rsRetVal (*cfline)(uchar *line, rule_t **pfCurr);
 	rsRetVal (*processConfFile)(uchar *pConfFile);
 	rsRetVal (*GetNbrActActions)(int *);
+	/* version 4 -- 2010-07-23 rgerhards */
+	/* "just" added global variables
+	 * FYI: we reconsider repacking as a non-object, as only the core currently
+	 * accesses this module. The current object structure complicates things without
+	 * any real benefit.
+	 */
 ENDinterface(conf)
-#define confCURR_IF_VERSION 3 /* increment whenever you change the interface structure! */
+#define confCURR_IF_VERSION 4 /* increment whenever you change the interface structure! */
 /* in Version 3, entry point "ReInitConf()" was removed, as we do not longer need
  * to support restart-type HUP -- rgerhards, 2009-07-15
  */
diff --git a/runtime/glbl.h b/runtime/glbl.h
index 4b4bdf83..82bd1a7a 100644
--- a/runtime/glbl.h
+++ b/runtime/glbl.h
@@ -76,7 +76,7 @@ BEGINinterface(glbl) /* name must also be changed in ENDinterface macro! */
 	 */
 	SIMP_PROP(FdSetSize, int)
 	/* v7: was neeeded to mean v5+v6 - do NOT add anything else for that version! */
-	/* next change is v8! */
+	/* next is v8! */
 #undef	SIMP_PROP
 ENDinterface(glbl)
 #define glblCURR_IF_VERSION 7 /* increment whenever you change the interface structure! */
diff --git a/runtime/rsyslog.h b/runtime/rsyslog.h
index 602ba5dc..38de1043 100644
--- a/runtime/rsyslog.h
+++ b/runtime/rsyslog.h
@@ -201,8 +201,6 @@ typedef enum {
 	FIOP_EREREGEX = 5	/* matches a ERE regular expression? */
 } fiop_t;
 
-//typedef enum cslCmdHdlrType ecslCmdHdrlType;
-//typedef enum ecslConfObjType;
 /* types of configuration handlers
  */
 typedef enum cslCmdHdlrType {
@@ -226,6 +224,12 @@ typedef enum cslCmdHdlrType {
 typedef enum cslConfObjType {
 	eConfObjGlobal = 0,	/* global directives */
 	eConfObjAction,		/* action-specific directives */
+	/* now come states that indicate that we wait for a block-end. These are
+	 * states that permit us to do some safety checks and they hopefully ease
+	 * migration to a "real" parser/grammar.
+	 */
+	eConfObjActionWaitEnd,
+	eConfObjAlways		/* always valid, very special case (guess $End only!) */
 } ecslConfObjType;
 
 
@@ -477,6 +481,12 @@ enum rsRetVal_				/** return value. All methods return this if not specified oth
 	RS_RET_ERR_EPOLL_CTL = -2163,	/**< epol_ctll() returned with an unexpected error code */
 	RS_RET_TIMEOUT = -2164,		/**< timeout occured during operation */
 	RS_RET_RCV_ERR = -2165,		/**< error occured during socket rcv operation */
+	RS_RET_INVLD_CONF_OBJ= -2166,	/**< invalid config object (e.g. $Begin conf statement) */
+	RS_RET_CONF_NOT_GLBL = -2167,	/**< $Begin not in global scope */
+	RS_RET_CONF_IN_GLBL = -2168,	/**< $End when in global scope */
+	RS_RET_CONF_INVLD_END = -2169,	/**< $End for wrong conf object (probably nesting error) */
+	RS_RET_CONF_INVLD_SCOPE = -2170,/**< config statement not valid in current scope (e.g. global stmt in action block) */
+	RS_RET_CONF_END_NO_ACT = -2171,	/**< end of action block, but no actual action specified */
 
 	/* RainerScript error messages (range 1000.. 1999) */
 	RS_RET_SYSVAR_NOT_FOUND = 1001, /**< system variable could not be found (maybe misspelled) */