src/format/ByteCode.h

   1 #ifndef _SQUID_FMT_BYTECODE_H
   2 #define _SQUID_FMT_BYTECODE_H
   3
   4 /*
   5  * Squid configuration allows users to define custom formats in
   6  * several components.
   7  * - logging
   8  * - external ACL input
   9  * - deny page URL
  10  *
  11  * These enumerations and classes define the API for parsing of
  12  * format directives to define these patterns. Along with output
  13  * functionality to produce formatted buffers.
  14  */
  15
  16 namespace Format
  17 {
  18
  19 /*
  20  * Bytecodes for the configureable format stuff
  21  */
  22 typedef enum {
  23     LFT_NONE,                   /* dummy */
  24
  25     /* arbitrary string between tokens */
  26     LFT_STRING,
  27
  28     /* client TCP connection remote end details */
  29     LFT_CLIENT_IP_ADDRESS,
  30     LFT_CLIENT_FQDN,
  31     LFT_CLIENT_PORT,
  32     LFT_CLIENT_EUI,
  33
  34     /* client TCP connection local end details */
  35     LFT_CLIENT_LOCAL_IP,
  36     LFT_CLIENT_LOCAL_PORT,
  37     /*LFT_CLIENT_LOCAL_FQDN, (rDNS) */
  38     LFT_CLIENT_LOCAL_TOS,
  39     LFT_CLIENT_LOCAL_NFMARK,
  40
  41     /* client connection local squid.conf details */
  42     LFT_LOCAL_LISTENING_IP,
  43     LFT_LOCAL_LISTENING_PORT,
  44     /*LFT_LOCAL_LISTENING_NAME, (myportname) */
  45
  46     /* server TCP connection remote end details */
  47     LFT_SERVER_IP_ADDRESS,
  48     LFT_SERVER_FQDN_OR_PEER_NAME,
  49     LFT_SERVER_PORT,
  50
  51     /* server TCP connection local end details */
  52     LFT_SERVER_LOCAL_IP,
  53     LFT_SERVER_LOCAL_IP_OLD_27,
  54     LFT_SERVER_LOCAL_PORT,
  55     LFT_SERVER_LOCAL_TOS,
  56     LFT_SERVER_LOCAL_NFMARK,
  57
  58     /* original Request-Line details recieved from client */
  59     LFT_CLIENT_REQ_METHOD,
  60     LFT_CLIENT_REQ_URI,
  61     LFT_CLIENT_REQ_URLPATH,
  62     /* LFT_CLIENT_REQ_QUERY, */
  63     LFT_CLIENT_REQ_VERSION,
  64
  65     /* Request-Line details recieved from client (legacy, filtered) */
  66     LFT_REQUEST_METHOD,
  67     LFT_REQUEST_URI,
  68     LFT_REQUEST_URLPATH_OLD_31,
  69     /*LFT_REQUEST_QUERY, */
  70     LFT_REQUEST_VERSION_OLD_2X,
  71     LFT_REQUEST_VERSION,
  72
  73     /* request header details pre-adaptation */
  74     LFT_REQUEST_HEADER,
  75     LFT_REQUEST_HEADER_ELEM,
  76     LFT_REQUEST_ALL_HEADERS,
  77
  78     /* request header details post-adaptation */
  79     LFT_ADAPTED_REQUEST_HEADER,
  80     LFT_ADAPTED_REQUEST_HEADER_ELEM,
  81     LFT_ADAPTED_REQUEST_ALL_HEADERS,
  82
  83     /* Request-Line details sent to the server/peer */
  84     LFT_SERVER_REQ_METHOD,
  85     LFT_SERVER_REQ_URI,
  86     LFT_SERVER_REQ_URLPATH,
  87     /*LFT_SERVER_REQ_QUERY, */
  88     LFT_SERVER_REQ_VERSION,
  89
  90     /* request meta details */
  91     LFT_REQUEST_SIZE_TOTAL,
  92     /*LFT_REQUEST_SIZE_LINE, */
  93     LFT_REQUEST_SIZE_HEADERS,
  94     /*LFT_REQUEST_SIZE_BODY, */
  95     /*LFT_REQUEST_SIZE_BODY_NO_TE, */
  96
  97     /* original Status-Line details recieved from server */
  98     // XXX: todo
  99
 100     /* Status-Line details sent to the client */
 101     // XXX: todo
 102
 103     /* response Status-Line details (legacy, filtered) */
 104     LFT_HTTP_SENT_STATUS_CODE_OLD_30,
 105     LFT_HTTP_SENT_STATUS_CODE,
 106     LFT_HTTP_RECEIVED_STATUS_CODE,
 107     /*LFT_HTTP_STATUS, */
 108     LFT_HTTP_BODY_BYTES_READ,
 109
 110     /* response header details pre-adaptation */
 111     LFT_REPLY_HEADER,
 112     LFT_REPLY_HEADER_ELEM,
 113     LFT_REPLY_ALL_HEADERS,
 114
 115     /* response header details post-adaptation */
 116     /* LFT_ADAPTED_REPLY_HEADER, */
 117     /* LFT_ADAPTED_REPLY_HEADER_ELEM, */
 118     /* LFT_ADAPTED_REPLY_ALL_HEADERS, */
 119
 120     /* response meta details */
 121     LFT_REPLY_SIZE_TOTAL,
 122     LFT_REPLY_HIGHOFFSET,
 123     LFT_REPLY_OBJECTSIZE,
 124     /*LFT_REPLY_SIZE_LINE, */
 125     LFT_REPLY_SIZE_HEADERS,
 126     /*LFT_REPLY_SIZE_BODY, */
 127     /*LFT_REPLY_SIZE_BODY_NO_TE, */
 128
 129     /* client credentials */
 130     LFT_USER_NAME,   /* any source will do */
 131     LFT_USER_LOGIN,
 132     LFT_USER_IDENT,
 133     /*LFT_USER_REALM, */
 134     /*LFT_USER_SCHEME, */
 135     LFT_USER_EXTERNAL,
 136     /* LFT_USER_SSL_CERT, */
 137
 138     /* global time details */
 139     LFT_TIME_SECONDS_SINCE_EPOCH,
 140     LFT_TIME_SUBSECOND,
 141     LFT_TIME_LOCALTIME,
 142     LFT_TIME_GMT,
 143
 144     /* processing time details */
 145     LFT_TIME_TO_HANDLE_REQUEST,
 146     LFT_PEER_RESPONSE_TIME,
 147     LFT_TOTAL_SERVER_SIDE_RESPONSE_TIME,
 148     LFT_DNS_WAIT_TIME,
 149
 150     /* Squid internal processing details */
 151     LFT_SQUID_STATUS,
 152     LFT_SQUID_ERROR,
 153     LFT_SQUID_ERROR_DETAIL,
 154     LFT_SQUID_HIERARCHY,
 155
 156     LFT_MIME_TYPE,
 157     LFT_TAG,
 158     LFT_IO_SIZE_TOTAL,
 159     LFT_EXT_LOG,
 160
 161     LFT_SEQUENCE_NUMBER,
 162
 163 #if USE_ADAPTATION
 164     LFT_ADAPTATION_SUM_XACT_TIMES,
 165     LFT_ADAPTATION_ALL_XACT_TIMES,
 166     LFT_ADAPTATION_LAST_HEADER,
 167     LFT_ADAPTATION_LAST_HEADER_ELEM,
 168     LFT_ADAPTATION_LAST_ALL_HEADERS,
 169 #endif
 170
 171 #if ICAP_CLIENT
 172
 173     LFT_ICAP_TOTAL_TIME,
 174
 175     LFT_ICAP_ADDR,
 176     LFT_ICAP_SERV_NAME,
 177     LFT_ICAP_REQUEST_URI,
 178     LFT_ICAP_REQUEST_METHOD,
 179     LFT_ICAP_BYTES_SENT,
 180     LFT_ICAP_BYTES_READ,
 181     LFT_ICAP_BODY_BYTES_READ,
 182
 183     LFT_ICAP_REQ_HEADER,
 184     LFT_ICAP_REQ_HEADER_ELEM,
 185     LFT_ICAP_REQ_ALL_HEADERS,
 186
 187     LFT_ICAP_REP_HEADER,
 188     LFT_ICAP_REP_HEADER_ELEM,
 189     LFT_ICAP_REP_ALL_HEADERS,
 190
 191     LFT_ICAP_TR_RESPONSE_TIME,
 192     LFT_ICAP_IO_TIME,
 193     LFT_ICAP_OUTCOME,
 194     LFT_ICAP_STATUS_CODE,
 195 #endif
 196
 197 #if USE_SSL
 198     LFT_SSL_BUMP_MODE,
 199     LFT_SSL_USER_CERT_SUBJECT,
 200     LFT_SSL_USER_CERT_ISSUER,
 201 #endif
 202
 203     LFT_NOTE,
 204     LFT_PERCENT                 /* special string cases for escaped chars */
 205 } ByteCode_t;
 206
 207 /// Quoting style for a format output.
 208 enum Quoting {
 209     LOG_QUOTE_NONE = 0,
 210     LOG_QUOTE_QUOTES,
 211     LOG_QUOTE_MIMEBLOB,
 212     LOG_QUOTE_URL,
 213     LOG_QUOTE_RAW
 214 };
 215
 216 } // namespace Format
 217
 218 #endif /* _SQUID_FMT_BYTECODE_H */