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_URLDOMAIN,
  62     LFT_CLIENT_REQ_URLPATH,
  63     /* LFT_CLIENT_REQ_QUERY, */
  64     LFT_CLIENT_REQ_VERSION,
  65
  66     /* Request-Line details recieved from client (legacy, filtered) */
  67     LFT_REQUEST_METHOD,
  68     LFT_REQUEST_URI,
  69     LFT_REQUEST_URLPATH_OLD_31,
  70     /*LFT_REQUEST_QUERY, */
  71     LFT_REQUEST_VERSION_OLD_2X,
  72     LFT_REQUEST_VERSION,
  73
  74     /* request header details pre-adaptation */
  75     LFT_REQUEST_HEADER,
  76     LFT_REQUEST_HEADER_ELEM,
  77     LFT_REQUEST_ALL_HEADERS,
  78
  79     /* request header details post-adaptation */
  80     LFT_ADAPTED_REQUEST_HEADER,
  81     LFT_ADAPTED_REQUEST_HEADER_ELEM,
  82     LFT_ADAPTED_REQUEST_ALL_HEADERS,
  83
  84     /* Request-Line details sent to the server/peer */
  85     LFT_SERVER_REQ_METHOD,
  86     LFT_SERVER_REQ_URI,
  87     LFT_SERVER_REQ_URLPATH,
  88     /*LFT_SERVER_REQ_QUERY, */
  89     LFT_SERVER_REQ_VERSION,
  90
  91     /* request meta details */
  92     LFT_CLIENT_REQUEST_SIZE_TOTAL,
  93     LFT_CLIENT_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_ADAPTED_REPLY_SIZE_TOTAL,
 122     LFT_REPLY_HIGHOFFSET,
 123     LFT_REPLY_OBJECTSIZE,
 124     LFT_ADAPTED_REPLY_SIZE_HEADERS,
 125     /*LFT_REPLY_SIZE_BODY, */
 126     /*LFT_REPLY_SIZE_BODY_NO_TE, */
 127
 128     LFT_CLIENT_IO_SIZE_TOTAL,
 129
 130     /* client credentials */
 131     LFT_USER_NAME,   /* any source will do */
 132     LFT_USER_LOGIN,
 133     LFT_USER_IDENT,
 134     /*LFT_USER_REALM, */
 135     /*LFT_USER_SCHEME, */
 136     LFT_USER_EXTERNAL,
 137     /* LFT_USER_SSL_CERT, */
 138
 139     /* global time details */
 140     LFT_TIME_SECONDS_SINCE_EPOCH,
 141     LFT_TIME_SUBSECOND,
 142     LFT_TIME_LOCALTIME,
 143     LFT_TIME_GMT,
 144     LFT_TIME_START, // the time the master transaction started
 145
 146     /* processing time details */
 147     LFT_TIME_TO_HANDLE_REQUEST,
 148     LFT_PEER_RESPONSE_TIME,
 149     LFT_TOTAL_SERVER_SIDE_RESPONSE_TIME,
 150     LFT_DNS_WAIT_TIME,
 151
 152     /* Squid internal processing details */
 153     LFT_SQUID_STATUS,
 154     LFT_SQUID_ERROR,
 155     LFT_SQUID_ERROR_DETAIL,
 156     LFT_SQUID_HIERARCHY,
 157
 158     LFT_MIME_TYPE,
 159     LFT_TAG,
 160     LFT_EXT_LOG,
 161
 162     LFT_SEQUENCE_NUMBER,
 163
 164 #if USE_ADAPTATION
 165     LFT_ADAPTATION_SUM_XACT_TIMES,
 166     LFT_ADAPTATION_ALL_XACT_TIMES,
 167     LFT_ADAPTATION_LAST_HEADER,
 168     LFT_ADAPTATION_LAST_HEADER_ELEM,
 169     LFT_ADAPTATION_LAST_ALL_HEADERS,
 170 #endif
 171
 172 #if ICAP_CLIENT
 173
 174     LFT_ICAP_TOTAL_TIME,
 175
 176     LFT_ICAP_ADDR,
 177     LFT_ICAP_SERV_NAME,
 178     LFT_ICAP_REQUEST_URI,
 179     LFT_ICAP_REQUEST_METHOD,
 180     LFT_ICAP_BYTES_SENT,
 181     LFT_ICAP_BYTES_READ,
 182     LFT_ICAP_BODY_BYTES_READ,
 183
 184     LFT_ICAP_REQ_HEADER,
 185     LFT_ICAP_REQ_HEADER_ELEM,
 186     LFT_ICAP_REQ_ALL_HEADERS,
 187
 188     LFT_ICAP_REP_HEADER,
 189     LFT_ICAP_REP_HEADER_ELEM,
 190     LFT_ICAP_REP_ALL_HEADERS,
 191
 192     LFT_ICAP_TR_RESPONSE_TIME,
 193     LFT_ICAP_IO_TIME,
 194     LFT_ICAP_OUTCOME,
 195     LFT_ICAP_STATUS_CODE,
 196 #endif
 197     LFT_CREDENTIALS,
 198
 199 #if USE_OPENSSL
 200     LFT_SSL_BUMP_MODE,
 201     LFT_SSL_USER_CERT_SUBJECT,
 202     LFT_SSL_USER_CERT_ISSUER,
 203 #endif
 204
 205     LFT_NOTE,
 206     LFT_PERCENT                 /* special string cases for escaped chars */
 207 } ByteCode_t;
 208
 209 /// Quoting style for a format output.
 210 enum Quoting {
 211     LOG_QUOTE_NONE = 0,
 212     LOG_QUOTE_QUOTES,
 213     LOG_QUOTE_MIMEBLOB,
 214     LOG_QUOTE_URL,
 215     LOG_QUOTE_RAW
 216 };
 217
 218 } // namespace Format
 219
 220 #endif /* _SQUID_FMT_BYTECODE_H */