2 #include "format/Config.h"
3 #include "format/Token.h"
4 #include "format/TokenTableEntry.h"
5 #include "SquidConfig.h"
8 const char *Format::log_tags
[] = {
12 "TCP_REFRESH_UNMODIFIED",
13 "TCP_REFRESH_FAIL", // same tag logged for LOG_TCP_REFRESH_FAIL_OLD and
14 "TCP_REFRESH_FAIL", // LOG_TCP_REFRESH_FAIL_ERR for backward-compatibility
15 "TCP_REFRESH_MODIFIED",
16 "TCP_CLIENT_REFRESH_MISS",
34 // Due to token overlaps between 1 and 2 letter tokens (Bug 3310)
35 // We split the token table into sets determined by the token length
40 static TokenTableEntry TokenTable1C
[] = {
42 {">a", LFT_CLIENT_IP_ADDRESS
},
43 {">p", LFT_CLIENT_PORT
},
44 {">A", LFT_CLIENT_FQDN
},
46 {"<a", LFT_SERVER_IP_ADDRESS
},
47 {"<p", LFT_SERVER_PORT
},
48 {"<A", LFT_SERVER_FQDN_OR_PEER_NAME
},
50 {">h", LFT_REQUEST_HEADER
},
51 {">h", LFT_REQUEST_ALL_HEADERS
},
52 {"<h", LFT_REPLY_HEADER
},
53 {"<h", LFT_REPLY_ALL_HEADERS
},
55 {">v", LFT_REQUEST_VERSION_OLD_2X
},
59 {NULL
, LFT_NONE
} /* this must be last */
63 static TokenTableEntry TokenTable2C
[] = {
65 {">la", LFT_CLIENT_LOCAL_IP
},
66 {"la", LFT_LOCAL_LISTENING_IP
},
67 {">lp", LFT_CLIENT_LOCAL_PORT
},
68 {"lp", LFT_LOCAL_LISTENING_PORT
},
69 /*{ "lA", LFT_LOCAL_NAME }, */
71 {"<la", LFT_SERVER_LOCAL_IP
},
72 {"oa", LFT_SERVER_LOCAL_IP_OLD_27
},
73 {"<lp", LFT_SERVER_LOCAL_PORT
},
74 /* {"ot", LFT_PEER_OUTGOING_TOS}, */
76 {"ts", LFT_TIME_SECONDS_SINCE_EPOCH
},
77 {"tu", LFT_TIME_SUBSECOND
},
78 {"tl", LFT_TIME_LOCALTIME
},
80 {"tr", LFT_TIME_TO_HANDLE_REQUEST
},
82 {"<pt", LFT_PEER_RESPONSE_TIME
},
83 {"<tt", LFT_TOTAL_SERVER_SIDE_RESPONSE_TIME
},
84 {"dt", LFT_DNS_WAIT_TIME
},
86 {">ha", LFT_ADAPTED_REQUEST_HEADER
},
87 {">ha", LFT_ADAPTED_REQUEST_ALL_HEADERS
},
89 {"un", LFT_USER_NAME
},
90 {"ul", LFT_USER_LOGIN
},
91 /*{ "ur", LFT_USER_REALM }, */
92 /*{ "us", LFT_USER_SCHEME }, */
93 {"ui", LFT_USER_IDENT
},
94 {"ue", LFT_USER_EXTERNAL
},
96 {"Hs", LFT_HTTP_SENT_STATUS_CODE_OLD_30
},
97 {">Hs", LFT_HTTP_SENT_STATUS_CODE
},
98 {"<Hs", LFT_HTTP_RECEIVED_STATUS_CODE
},
99 /*{ "Ht", LFT_HTTP_STATUS }, */
100 {"<bs", LFT_HTTP_BODY_BYTES_READ
},
102 {"Ss", LFT_SQUID_STATUS
},
103 {"Sh", LFT_SQUID_HIERARCHY
},
105 {"mt", LFT_MIME_TYPE
},
107 {">rm", LFT_CLIENT_REQ_METHOD
},
108 {">ru", LFT_CLIENT_REQ_URI
},
109 {">rp", LFT_CLIENT_REQ_URLPATH
},
110 /*{">rq", LFT_CLIENT_REQ_QUERY},*/
111 {">rv", LFT_CLIENT_REQ_VERSION
},
113 {"rm", LFT_REQUEST_METHOD
},
114 {"ru", LFT_REQUEST_URI
}, /* doesn't include the query-string */
115 {"rp", LFT_REQUEST_URLPATH_OLD_31
},
116 /* { "rq", LFT_REQUEST_QUERY }, * / / * the query-string, INCLUDING the leading ? */
117 {"rv", LFT_REQUEST_VERSION
},
119 {"<rm", LFT_SERVER_REQ_METHOD
},
120 {"<ru", LFT_SERVER_REQ_URI
},
121 {"<rp", LFT_SERVER_REQ_URLPATH
},
122 /*{"<rq", LFT_SERVER_REQ_QUERY},*/
123 {"<rv", LFT_SERVER_REQ_VERSION
},
125 {">st", LFT_REQUEST_SIZE_TOTAL
},
126 /*{ ">sl", LFT_REQUEST_SIZE_LINE }, * / / * the request line "GET ... " */
127 {">sh", LFT_REQUEST_SIZE_HEADERS
},
128 /*{ ">sb", LFT_REQUEST_SIZE_BODY }, */
129 /*{ ">sB", LFT_REQUEST_SIZE_BODY_NO_TE }, */
131 {"<st", LFT_REPLY_SIZE_TOTAL
},
132 {"<sH", LFT_REPLY_HIGHOFFSET
},
133 {"<sS", LFT_REPLY_OBJECTSIZE
},
134 /*{ "<sl", LFT_REPLY_SIZE_LINE }, * / / * the reply line (protocol, code, text) */
135 {"<sh", LFT_REPLY_SIZE_HEADERS
},
136 /*{ "<sb", LFT_REPLY_SIZE_BODY }, */
137 /*{ "<sB", LFT_REPLY_SIZE_BODY_NO_TE }, */
140 {"st", LFT_IO_SIZE_TOTAL
},
142 {"sn", LFT_SEQUENCE_NUMBER
},
144 {NULL
, LFT_NONE
} /* this must be last */
147 /// Miscellaneous >2 byte tokens
148 static TokenTableEntry TokenTableMisc
[] = {
149 {">eui", LFT_CLIENT_EUI
},
150 {"err_code", LFT_SQUID_ERROR
},
151 {"err_detail", LFT_SQUID_ERROR_DETAIL
},
152 {NULL
, LFT_NONE
} /* this must be last */
156 static TokenTableEntry TokenTableAdapt
[] = {
157 {"all_trs", LFT_ADAPTATION_ALL_XACT_TIMES
},
158 {"sum_trs", LFT_ADAPTATION_SUM_XACT_TIMES
},
159 {"<last_h", LFT_ADAPTATION_LAST_HEADER
},
160 {NULL
, LFT_NONE
} /* this must be last */
165 /// ICAP (icap::) tokens
166 static TokenTableEntry TokenTableIcap
[] = {
167 {"tt", LFT_ICAP_TOTAL_TIME
},
168 {"<last_h", LFT_ADAPTATION_LAST_HEADER
}, // deprecated
170 {"<A", LFT_ICAP_ADDR
},
171 {"<service_name", LFT_ICAP_SERV_NAME
},
172 {"ru", LFT_ICAP_REQUEST_URI
},
173 {"rm", LFT_ICAP_REQUEST_METHOD
},
174 {">st", LFT_ICAP_BYTES_SENT
},
175 {"<st", LFT_ICAP_BYTES_READ
},
176 {"<bs", LFT_ICAP_BODY_BYTES_READ
},
178 {">h", LFT_ICAP_REQ_HEADER
},
179 {"<h", LFT_ICAP_REP_HEADER
},
181 {"tr", LFT_ICAP_TR_RESPONSE_TIME
},
182 {"tio", LFT_ICAP_IO_TIME
},
183 {"to", LFT_ICAP_OUTCOME
},
184 {"Hs", LFT_ICAP_STATUS_CODE
},
186 {NULL
, LFT_NONE
} /* this must be last */
191 // SSL (ssl::) tokens
192 static TokenTableEntry TokenTableSsl
[] = {
193 {"bump_mode", LFT_SSL_BUMP_MODE
},
194 {">cert_subject", LFT_SSL_USER_CERT_SUBJECT
},
195 {">cert_issuer", LFT_SSL_USER_CERT_ISSUER
},
199 } // namespace Format
201 /// Register all components custom format tokens
203 Format::Token::Init()
205 // TODO standard log tokens
206 // TODO external ACL fmt tokens
209 TheConfig
.registerTokens(String("adapt"),::Format::TokenTableAdapt
);
212 TheConfig
.registerTokens(String("icap"),::Format::TokenTableIcap
);
215 TheConfig
.registerTokens(String("ssl"),::Format::TokenTableSsl
);
219 /// Scans a token table to see if the next token exists there
220 /// returns a pointer to next unparsed byte and updates type member if found
222 Format::Token::scanForToken(TokenTableEntry
const table
[], const char *cur
)
224 for (TokenTableEntry
const *lte
= table
; lte
->configTag
!= NULL
; ++lte
) {
225 debugs(46, 8, HERE
<< "compare tokens '" << lte
->configTag
<< "' with '" << cur
<< "'");
226 if (strncmp(lte
->configTag
, cur
, strlen(lte
->configTag
)) == 0) {
227 type
= lte
->tokenType
;
228 label
= lte
->configTag
;
229 debugs(46, 7, HERE
<< "Found token '" << label
<< "'");
230 return cur
+ strlen(lte
->configTag
);
236 /* parses a single token. Returns the token length in characters,
237 * and fills in the lt item with the token information.
238 * def is for sure null-terminated
241 Format::Token::parse(const char *def
, Quoting
*quoting
)
243 const char *cur
= def
;
247 l
= strcspn(cur
, "%");
251 /* it's a string for sure, until \0 or the next % */
252 cp
= (char *)xmalloc(l
+ 1);
253 xstrncpy(cp
, cur
, l
+ 1);
262 if (*quoting
== LOG_QUOTE_NONE
)
263 *quoting
= LOG_QUOTE_QUOTES
;
264 else if (*quoting
== LOG_QUOTE_QUOTES
)
265 *quoting
= LOG_QUOTE_NONE
;
270 if (*quoting
== LOG_QUOTE_NONE
)
271 *quoting
= LOG_QUOTE_MIMEBLOB
;
276 if (*quoting
== LOG_QUOTE_MIMEBLOB
)
277 *quoting
= LOG_QUOTE_NONE
;
294 // select quoting style for his particular token
298 quote
= LOG_QUOTE_QUOTES
;
303 quote
= LOG_QUOTE_RAW
;
308 quote
= LOG_QUOTE_MIMEBLOB
;
313 quote
= LOG_QUOTE_URL
;
333 if (xisdigit(*cur
)) {
334 widthMin
= strtol(cur
, &endp
, 10);
338 if (*cur
== '.' && xisdigit(*(++cur
))) {
339 widthMax
= strtol(cur
, &endp
, 10);
346 l
= strcspn(cur
, "}");
347 cp
= (char *)xmalloc(l
+ 1);
348 xstrncpy(cp
, cur
, l
+ 1);
358 // Scan each registered token namespace
359 debugs(46, 9, HERE
<< "check for token in " << TheConfig
.tokens
.size() << " namespaces.");
360 for (std::list
<TokenNamespace
>::const_iterator itr
= TheConfig
.tokens
.begin(); itr
!= TheConfig
.tokens
.end(); ++itr
) {
361 debugs(46, 7, HERE
<< "check for possible " << itr
->prefix
<< ":: token");
362 const size_t len
= itr
->prefix
.size();
363 if (itr
->prefix
.cmp(cur
, len
) == 0 && cur
[len
] == ':' && cur
[len
+1] == ':') {
364 debugs(46, 5, HERE
<< "check for " << itr
->prefix
<< ":: token in '" << cur
<< "'");
365 const char *old
= cur
;
366 cur
= scanForToken(itr
->tokenSet
, cur
+len
+2);
367 if (old
!= cur
) // found
369 else // reset to start of namespace
374 if (type
== LFT_NONE
) {
375 // For upward compatibility, assume "http::" prefix as default prefix
376 // for all log access formatting codes, except those starting with a
377 // "%" or a known namespace. (ie "icap::", "adapt::")
378 if (strncmp(cur
,"http::", 6) == 0 && *(cur
+6) != '%' )
381 // NP: scan the sets of tokens in decreasing size to guarantee no
382 // mistakes made with overlapping names. (Bug 3310)
384 // Scan for various long tokens
385 debugs(46, 5, HERE
<< "scan for possible Misc token");
386 cur
= scanForToken(TokenTableMisc
, cur
);
387 // scan for 2-char tokens
388 if (type
== LFT_NONE
) {
389 debugs(46, 5, HERE
<< "scan for possible 2C token");
390 cur
= scanForToken(TokenTable2C
, cur
);
392 // finally scan for 1-char tokens.
393 if (type
== LFT_NONE
) {
394 debugs(46, 5, HERE
<< "scan for possible 1C token");
395 cur
= scanForToken(TokenTable1C
, cur
);
399 if (type
== LFT_NONE
) {
400 fatalf("Can't parse configuration token: '%s'\n", def
);
413 case LFT_ADAPTATION_LAST_HEADER
:
417 case LFT_ICAP_REQ_HEADER
:
419 case LFT_ICAP_REP_HEADER
:
422 case LFT_ADAPTED_REQUEST_HEADER
:
424 case LFT_REQUEST_HEADER
:
426 case LFT_REPLY_HEADER
:
429 char *header
= data
.string
;
430 char *cp
= strchr(header
, ':');
436 if (*cp
== ',' || *cp
== ';' || *cp
== ':') {
437 data
.header
.separator
= *cp
;
440 data
.header
.separator
= ',';
443 data
.header
.element
= cp
;
446 case LFT_REQUEST_HEADER
:
447 type
= LFT_REQUEST_HEADER_ELEM
;
450 case LFT_ADAPTED_REQUEST_HEADER
:
451 type
= LFT_ADAPTED_REQUEST_HEADER_ELEM
;
454 case LFT_REPLY_HEADER
:
455 type
= LFT_REPLY_HEADER_ELEM
;
458 case LFT_ADAPTATION_LAST_HEADER
:
459 type
= LFT_ADAPTATION_LAST_HEADER_ELEM
;
463 case LFT_ICAP_REQ_HEADER
:
464 type
= LFT_ICAP_REQ_HEADER_ELEM
;
466 case LFT_ICAP_REP_HEADER
:
467 type
= LFT_ICAP_REP_HEADER_ELEM
;
475 data
.header
.header
= header
;
478 case LFT_REQUEST_HEADER
:
479 type
= LFT_REQUEST_ALL_HEADERS
;
482 case LFT_ADAPTED_REQUEST_HEADER
:
483 type
= LFT_ADAPTED_REQUEST_ALL_HEADERS
;
486 case LFT_REPLY_HEADER
:
487 type
= LFT_REPLY_ALL_HEADERS
;
490 case LFT_ADAPTATION_LAST_HEADER
:
491 type
= LFT_ADAPTATION_LAST_ALL_HEADERS
;
495 case LFT_ICAP_REQ_HEADER
:
496 type
= LFT_ICAP_REQ_ALL_HEADERS
;
498 case LFT_ICAP_REP_HEADER
:
499 type
= LFT_ICAP_REP_ALL_HEADERS
;
505 Config
.onoff
.log_mime_hdrs
= 1;
510 case LFT_CLIENT_FQDN
:
511 Config
.onoff
.log_fqdn
= 1;
514 case LFT_TIME_SUBSECOND
:
521 for (i
= widthMax
; i
> 1; --i
)
529 case LFT_HTTP_SENT_STATUS_CODE_OLD_30
:
530 debugs(46, DBG_CRITICAL
, "WARNING: The \"Hs\" formatting code is deprecated. Use the \">Hs\" instead.");
531 type
= LFT_HTTP_SENT_STATUS_CODE
;
534 case LFT_SERVER_LOCAL_IP_OLD_27
:
535 debugs(46, DBG_CRITICAL
, "WARNING: The \"oa\" formatting code is deprecated. Use the \"<la\" instead.");
536 type
= LFT_SERVER_LOCAL_IP
;
539 case LFT_REQUEST_URLPATH_OLD_31
:
540 debugs(46, DBG_CRITICAL
, "WARNING: The \"rp\" formatting code is deprecated. Use the \">rp\" instead.");
541 type
= LFT_CLIENT_REQ_URLPATH
;
544 case LFT_REQUEST_VERSION_OLD_2X
:
545 debugs(46, DBG_CRITICAL
, "WARNING: The \">v\" formatting code is deprecated. Use the \">rv\" instead.");
546 type
= LFT_REQUEST_VERSION
;
551 debugs(46, DBG_CRITICAL
, "WARNING: The \">eui\" formatting code requires EUI features which are disabled in this Squid.");
562 Format::Token::~Token()
564 label
= NULL
; // drop reference to global static.
565 safe_free(data
.string
);
567 Token
*tokens
= next
;