- added sysvar class

- added PUSHSYSVAR operation to vm

7 files changed, 270 insertions, 6 deletions

diff --git a/Makefile.am b/Makefile.am
index 179c53f0..4d6865cd 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -5,6 +5,8 @@ rfc3195d_SOURCES = rfc3195d.c rsyslog.h
 rsyslogd_SOURCES = \
 	syslogd.c \
 	syslogd.h \
+	sysvar.c \
+	sysvar.h \
 	vm.c \
 	vm.h \
 	vmstk.c \
diff --git a/obj-types.h b/obj-types.h
index 577b93f2..79781e44 100644
--- a/obj-types.h
+++ b/obj-types.h
@@ -58,10 +58,11 @@ typedef enum {	/* IDs of known object "types/classes" */
 	OBJvmop = 9,
 	OBJvmprg = 10,
 	OBJvm = 11,
-	OBJvmstk = 12,
-	OBJexpr = 13	/* remeber to UPDATE OBJ_NUM_IDS (below) if you add one! */
+	OBJsysvar = 12,
+	OBJvmstk = 13,
+	OBJexpr = 14	/* remeber to UPDATE OBJ_NUM_IDS (below) if you add one! */
 } objID_t;	
-#define OBJ_NUM_IDS 14
+#define OBJ_NUM_IDS 15
 
 typedef enum {	/* IDs of base methods supported by all objects - used for jump table, so
 		 * they must start at zero and be incremented. -- rgerahrds, 2008-01-04
diff --git a/rsyslog.h b/rsyslog.h
index a64a13d9..8b4aa354 100644
--- a/rsyslog.h
+++ b/rsyslog.h
@@ -134,6 +134,11 @@ enum rsRetVal_				/** return value. All methods return this if not specified oth
 	RS_RET_INVALID_VMOP = -2057, /**< invalid virtual machine instruction */
 	RS_RET_INVALID_VAR = -2058, /**< a var_t or its content is unsuitable, eg. VARTYPE_NONE */
 	RS_RET_NOT_A_NUMBER = -2059, /**< e.g. conversion impossible because the string is not a number */
+
+	/* RainerScript error messages (range 1000.. 1999) */
+	RS_RET_SYSVAR_NOT_FOUND = 1001, /**< system variable could not be found (maybe misspelled) */
+
+	/* some generic error/status codes */
 	RS_RET_OK_DELETE_LISTENTRY = 1,	/**< operation successful, but callee requested the deletion of an entry (special state) */
 	RS_RET_TERMINATE_NOW = 2,	/**< operation successful, function is requested to terminate (mostly used with threads) */
 	RS_RET_NO_RUN = 3,		/**< operation successful, but function does not like to be executed */
diff --git a/syslogd.c b/syslogd.c
index b9400500..7d28a3cc 100644
--- a/syslogd.c
+++ b/syslogd.c
@@ -175,6 +175,7 @@
 #include "vmstk.h"
 #include "vm.h"
 #include "vmprg.h"
+#include "sysvar.h"
 
 /* definitions for objects we access */
 DEFobjCurrIf(expr)
@@ -3586,6 +3587,7 @@ static rsRetVal InitGlobalClasses(void)
 	CHKiRet(vmClassInit());
 	CHKiRet(vmopClassInit());
 	CHKiRet(vmprgClassInit());
+	CHKiRet(sysvarClassInit());
 	CHKiRet(varClassInit());
 	CHKiRet(ctok_tokenClassInit());
 	CHKiRet(ctokClassInit());
diff --git a/sysvar.c b/sysvar.c
new file mode 100644
index 00000000..c532c4dd
--- /dev/null
+++ b/sysvar.c
@@ -0,0 +1,198 @@
+/* sysvar.c - imlements rsyslog system variables
+ *
+ * At least for now, this class only has static functions and no
+ * instances.
+ *
+ * Module begun 2008-02-25 by Rainer Gerhards
+ *
+ * Copyright 2008 Rainer Gerhards and Adiscon GmbH.
+ *
+ * This file is part of rsyslog.
+ *
+ * Rsyslog is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Rsyslog is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Rsyslog.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * A copy of the GPL can be found in the file "COPYING" in this distribution.
+ */
+
+#include "config.h"
+#include <stdio.h>
+#include <stdlib.h>
+#include <assert.h>
+
+#include "rsyslog.h"
+#include "obj.h"
+#include "stringbuf.h"
+#include "sysvar.h"
+
+/* static data */
+DEFobjStaticHelpers
+DEFobjCurrIf(var)
+
+
+/* Standard-Constructor
+ */
+BEGINobjConstruct(sysvar) /* be sure to specify the object type also in END macro! */
+ENDobjConstruct(sysvar)
+
+
+/* ConstructionFinalizer
+ * rgerhards, 2008-01-09
+ */
+static rsRetVal
+sysvarConstructFinalize(sysvar_t __attribute__((unused)) *pThis)
+{
+	DEFiRet;
+	RETiRet;
+}
+
+
+/* destructor for the sysvar object */
+BEGINobjDestruct(sysvar) /* be sure to specify the object type also in END and CODESTART macros! */
+CODESTARTobjDestruct(sysvar)
+ENDobjDestruct(sysvar)
+
+
+/* This function returns the current date in different
+ * variants. It is used to construct the $NOW series of
+ * system properties. The returned buffer must be freed
+ * by the caller when no longer needed. If the function
+ * can not allocate memory, it returns a NULL pointer.
+ * Added 2007-07-10 rgerhards
+ * TODO: this was taken from msg.c and we should consolidate it with the code
+ * there. This is especially important when we increase the number of system
+ * variables (what we definitely want to do).
+ */
+typedef enum ENOWType { NOW_NOW, NOW_YEAR, NOW_MONTH, NOW_DAY, NOW_HOUR, NOW_MINUTE } eNOWType;
+static rsRetVal
+getNOW(eNOWType eNow, cstr_t **ppStr)
+{
+	DEFiRet;
+	uchar szBuf[16];
+	struct syslogTime t;
+
+	getCurrTime(&t);
+	switch(eNow) {
+	case NOW_NOW:
+		snprintf((char*) szBuf, sizeof(szBuf)/sizeof(uchar), "%4.4d-%2.2d-%2.2d", t.year, t.month, t.day);
+		break;
+	case NOW_YEAR:
+		snprintf((char*) szBuf, sizeof(szBuf)/sizeof(uchar), "%4.4d", t.year);
+		break;
+	case NOW_MONTH:
+		snprintf((char*) szBuf, sizeof(szBuf)/sizeof(uchar), "%2.2d", t.month);
+		break;
+	case NOW_DAY:
+		snprintf((char*) szBuf, sizeof(szBuf)/sizeof(uchar), "%2.2d", t.day);
+		break;
+	case NOW_HOUR:
+		snprintf((char*) szBuf, sizeof(szBuf)/sizeof(uchar), "%2.2d", t.hour);
+		break;
+	case NOW_MINUTE:
+		snprintf((char*) szBuf, sizeof(szBuf)/sizeof(uchar), "%2.2d", t.minute);
+		break;
+	}
+
+	/* now create a string object out of it and hand that over to the var */
+	CHKiRet(rsCStrConstructFromszStr(ppStr, szBuf));
+
+finalize_it:
+	RETiRet;
+}
+
+
+/* The function returns a system variable suitable for use with RainerScript. Most importantly, this means
+ * that the value is returned in a var_t object. The var_t is constructed inside this function and
+ * MUST be freed by the caller.
+ * rgerhards, 2008-02-25
+ */
+static rsRetVal
+GetVar(cstr_t *pstrVarName, var_t **ppVar)
+{
+	DEFiRet;
+	var_t *pVar;
+	cstr_t *pstrProp;
+
+	ASSERT(pstrVarName != NULL);
+	ASSERT(ppVar != NULL);
+
+	/* make sure we have a var_t instance */
+	CHKiRet(var.Construct(&pVar));
+	CHKiRet(var.ConstructFinalize(pVar));
+
+	/* now begin the actual variable evaluation */
+	if(!rsCStrSzStrCmp(pstrVarName, (uchar*)"now", sizeof("now") - 1)) {
+		CHKiRet(getNOW(NOW_NOW, &pstrProp));
+	} else if(!rsCStrSzStrCmp(pstrVarName, (uchar*)"year", sizeof("year") - 1)) {
+		CHKiRet(getNOW(NOW_YEAR, &pstrProp));
+	} else if(!rsCStrSzStrCmp(pstrVarName, (uchar*)"month", sizeof("month") - 1)) {
+		CHKiRet(getNOW(NOW_MONTH, &pstrProp));
+	} else if(!rsCStrSzStrCmp(pstrVarName, (uchar*)"day", sizeof("day") - 1)) {
+		CHKiRet(getNOW(NOW_DAY, &pstrProp));
+	} else if(!rsCStrSzStrCmp(pstrVarName, (uchar*)"hour", sizeof("hour") - 1)) {
+		CHKiRet(getNOW(NOW_HOUR, &pstrProp));
+	} else if(!rsCStrSzStrCmp(pstrVarName, (uchar*)"minute", sizeof("minute") - 1)) {
+		CHKiRet(getNOW(NOW_MINUTE, &pstrProp));
+	} else {
+		ABORT_FINALIZE(RS_RET_SYSVAR_NOT_FOUND);
+	}
+
+	/* now hand the string over to the var object */
+	CHKiRet(var.SetString(pVar, pstrProp));
+
+	/* finally store var */
+	*ppVar = pVar;
+
+finalize_it:
+	RETiRet;
+}
+
+
+/* queryInterface function
+ * rgerhards, 2008-02-21
+ */
+BEGINobjQueryInterface(sysvar)
+CODESTARTobjQueryInterface(sysvar)
+	if(pIf->ifVersion != sysvarCURR_IF_VERSION) { /* check for current version, increment on each change */
+		ABORT_FINALIZE(RS_RET_INTERFACE_NOT_SUPPORTED);
+	}
+
+	/* ok, we have the right interface, so let's fill it
+	 * Please note that we may also do some backwards-compatibility
+	 * work here (if we can support an older interface version - that,
+	 * of course, also affects the "if" above).
+	 */
+	pIf->oID = OBJsysvar;
+
+	pIf->Construct = sysvarConstruct;
+	pIf->ConstructFinalize = sysvarConstructFinalize;
+	pIf->Destruct = sysvarDestruct;
+	pIf->GetVar = GetVar;
+finalize_it:
+ENDobjQueryInterface(sysvar)
+
+
+/* Initialize the sysvar class. Must be called as the very first method
+ * before anything else is called inside this class.
+ * rgerhards, 2008-02-19
+ */
+BEGINObjClassInit(sysvar, 1) /* class, version */
+	/* request objects we use */
+	CHKiRet(objUse(var));
+
+	/* set our own handlers */
+	OBJSetMethodHandler(objMethod_CONSTRUCTION_FINALIZER, sysvarConstructFinalize);
+ENDObjClassInit(sysvar)
+
+/* vi:set ai:
+ */
diff --git a/sysvar.h b/sysvar.h
new file mode 100644
index 00000000..67a1450e
--- /dev/null
+++ b/sysvar.h
@@ -0,0 +1,46 @@
+/* The sysvar object. So far, no instance can be defined (makes logically no
+ * sense).
+ *
+ * Copyright 2008 Rainer Gerhards and Adiscon GmbH.
+ *
+ * This file is part of rsyslog.
+ *
+ * Rsyslog is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Rsyslog is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Rsyslog.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * A copy of the GPL can be found in the file "COPYING" in this distribution.
+ */
+#ifndef INCLUDED_SYSVAR_H
+#define INCLUDED_SYSVAR_H
+
+/* the sysvar object - not really used... */
+typedef struct sysvar_s {
+	BEGINobjInstance;	/* Data to implement generic object - MUST be the first data element! */
+} sysvar_t;
+
+
+/* interfaces */
+BEGINinterface(sysvar) /* name must also be changed in ENDinterface macro! */
+	INTERFACEObjDebugPrint(sysvar);
+	rsRetVal (*Construct)(sysvar_t **ppThis);
+	rsRetVal (*ConstructFinalize)(sysvar_t __attribute__((unused)) *pThis);
+	rsRetVal (*Destruct)(sysvar_t **ppThis);
+	rsRetVal (*GetVar)(cstr_t *pstrPropName, var_t **ppVar);
+ENDinterface(sysvar)
+#define sysvarCURR_IF_VERSION 1 /* increment whenever you change the interface structure! */
+
+
+/* prototypes */
+PROTOTYPEObj(sysvar);
+
+#endif /* #ifndef INCLUDED_SYSVAR_H */
diff --git a/vm.c b/vm.c
index 389a3cd1..c85df45f 100644
--- a/vm.c
+++ b/vm.c
@@ -29,12 +29,14 @@
 #include "rsyslog.h"
 #include "obj.h"
 #include "vm.h"
+#include "sysvar.h"
 #include "stringbuf.h"
 
 /* static data */
 DEFobjStaticHelpers
 DEFobjCurrIf(vmstk)
 DEFobjCurrIf(var)
+DEFobjCurrIf(sysvar)
 
 
 /* ------------------------------ instruction set implementation ------------------------------ *
@@ -242,18 +244,24 @@ CODESTARTop(PUSHMSGVAR)
 		CHKiRet(var.SetString(pVal, pstrVal));
 	} else {
 		/* we have a message, so pull value from there */
-var.DebugPrint(pOp->operand.pVar);
 		CHKiRet(msgGetMsgVar(pThis->pMsg, pOp->operand.pVar->val.pStr, &pVal));
 	}
 
 	/* if we reach this point, we have a valid pVal and can push it */
 	vmstk.Push(pThis->pStk, pVal);
-RUNLOG_STR("msgvar:");
-var.DebugPrint(pVal);
 finalize_it:
 ENDop(PUSHMSGVAR)
 
 
+BEGINop(PUSHSYSVAR) /* remember to set the instruction also in the ENDop macro! */
+	var_t *pVal; /* the value to push */
+CODESTARTop(PUSHSYSVAR)
+	CHKiRet(sysvar.GetVar(pOp->operand.pVar->val.pStr, &pVal));
+	vmstk.Push(pThis->pStk, pVal);
+finalize_it:
+ENDop(PUSHSYSVAR)
+
+
 /* ------------------------------ end instruction set implementation ------------------------------ */
 
 
@@ -323,6 +331,7 @@ execProg(vm_t *pThis, vmprg_t *pProg)
 			doOP(NOT);
 			doOP(PUSHCONSTANT);
 			doOP(PUSHMSGVAR);
+			doOP(PUSHSYSVAR);
 			doOP(PLUS);
 			doOP(MINUS);
 			doOP(TIMES);
@@ -433,6 +442,7 @@ BEGINObjClassInit(vm, 1) /* class, version */
 	/* request objects we use */
 	CHKiRet(objUse(vmstk));
 	CHKiRet(objUse(var));
+	CHKiRet(objUse(sysvar));
 
 	/* set our own handlers */
 	OBJSetMethodHandler(objMethod_DEBUGPRINT, vmDebugPrint);