rsyslog/tools/smtradfile.c
Rainer Gerhards b326c76f45 style: normalize C source formatting via clang-format (PoC)
This commit applies the new canonical formatting style using `clang-format` with custom settings (notably 4-space indentation), as part of our shift toward automated formatting normalization.

⚠️ No functional changes are included — only whitespace and layout modifications as produced by `clang-format`.

This change is part of the formatting modernization strategy discussed in:
https://github.com/rsyslog/rsyslog/issues/5747

Key context:
- Formatting is now treated as a disposable view, normalized via tooling.
- The `.clang-format` file defines the canonical style.
- A fixup script (`devtools/format-code.sh`) handles remaining edge cases.
- Formatting commits are added to `.git-blame-ignore-revs` to reduce noise.
- Developers remain free to format code however they prefer locally.
2025-07-16 13:56:21 +02:00

128 lines
3.8 KiB
C

/* smtradfile.c
* This is a strgen module for the traditional file format.
*
* Format generated:
* "%TIMESTAMP% %HOSTNAME% %syslogtag%%msg:::sp-if-no-1st-sp%%msg:::drop-last-lf%\n"
*
* NOTE: read comments in module-template.h to understand how this file
* works!
*
* File begun on 2010-06-01 by RGerhards
*
* Copyright 2010-2014 Rainer Gerhards and Adiscon GmbH.
*
* This file is part of rsyslog.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
* -or-
* see COPYING.ASL20 in the source distribution
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "config.h"
#include "rsyslog.h"
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include <errno.h>
#include "syslogd.h"
#include "conf.h"
#include "syslogd-types.h"
#include "template.h"
#include "msg.h"
#include "module-template.h"
#include "unicode-helper.h"
MODULE_TYPE_STRGEN
MODULE_TYPE_NOKEEP;
STRGEN_NAME("RSYSLOG_TraditionalFileFormat")
/* internal structures
*/
DEF_SMOD_STATIC_DATA;
/* config data */
/* This strgen tries to minimize the amount of reallocs be first obtaining pointers to all strings
* needed (including their length) and then calculating the actual space required. So when we
* finally copy, we know exactly what we need. So we do at most one alloc.
*/
BEGINstrgen
register int iBuf;
uchar *pTimeStamp;
uchar *pHOSTNAME;
size_t lenHOSTNAME;
uchar *pTAG;
int lenTAG;
uchar *pMSG;
size_t lenMSG;
size_t lenTotal;
CODESTARTstrgen;
/* first obtain all strings and their length (if not fixed) */
pTimeStamp = (uchar *)getTimeReported(pMsg, tplFmtRFC3164Date);
pHOSTNAME = (uchar *)getHOSTNAME(pMsg);
lenHOSTNAME = getHOSTNAMELen(pMsg);
getTAG(pMsg, &pTAG, &lenTAG, LOCK_MUTEX);
pMSG = getMSG(pMsg);
lenMSG = getMSGLen(pMsg);
/* calculate len, constants for spaces and similar fixed strings */
lenTotal = CONST_LEN_TIMESTAMP_3164 + 1 + lenHOSTNAME + 1 + lenTAG + lenMSG + 2;
if (pMSG[0] != ' ') ++lenTotal; /* then we need to introduce one additional space */
/* now make sure buffer is large enough */
if (lenTotal >= iparam->lenBuf) CHKiRet(ExtendBuf(iparam, lenTotal));
/* and concatenate the resulting string */
memcpy(iparam->param, pTimeStamp, CONST_LEN_TIMESTAMP_3164);
iparam->param[CONST_LEN_TIMESTAMP_3164] = ' ';
memcpy(iparam->param + CONST_LEN_TIMESTAMP_3164 + 1, pHOSTNAME, lenHOSTNAME);
iBuf = CONST_LEN_TIMESTAMP_3164 + 1 + lenHOSTNAME;
iparam->param[iBuf++] = ' ';
memcpy(iparam->param + iBuf, pTAG, lenTAG);
iBuf += lenTAG;
if (pMSG[0] != ' ') iparam->param[iBuf++] = ' ';
memcpy(iparam->param + iBuf, pMSG, lenMSG);
iBuf += lenMSG;
/* trailer */
iparam->param[iBuf++] = '\n';
iparam->param[iBuf] = '\0';
iparam->lenStr = lenTotal - 1; /* do not count \0! */
finalize_it:
ENDstrgen
BEGINmodExit
CODESTARTmodExit;
ENDmodExit
BEGINqueryEtryPt
CODESTARTqueryEtryPt;
CODEqueryEtryPt_STD_SMOD_QUERIES;
ENDqueryEtryPt
BEGINmodInit(smtradfile)
CODESTARTmodInit;
*ipIFVersProvided = CURR_MOD_IF_VERSION; /* we only support the current interface specification */
CODEmodInit_QueryRegCFSLineHdlr dbgprintf("traditional file format strgen init called, compiled with version %s\n",
VERSION);
ENDmodInit