Class: HTTPApacheFormatAccessLogger

• Inheritance
• Description
• Class protocol
  • defaults
• Instance protocol
  • accessing
  • actions
  • html presentation
  • parsing

Inheritance:

   Object
   |
   +--HTTPAccessLogger
      |
      +--HTTPFileAccessLogger
         |
         +--HTTPApacheFormatAccessLogger

Package:

stx:goodies/webServer

Category:

Net-Communication-HTTP-Server

Version:

rev: 1.17 date: 2017/11/29 10:26:04

user: cg

file: HTTPApacheFormatAccessLogger.st directory: goodies/webServer

module: stx stc-classLibrary: webServer

Author:

Christian Penk

Description:

Generates Apache compatible logs

Apache Format directives:

    %...a:          Remote IP-address
    %...A:          Local IP-address
    %...B:          Bytes sent, excluding HTTP headers.
    %...b:          Bytes sent, excluding HTTP headers. In CLF format
            i.e. a '-' rather than a 0 when no bytes are sent.
    %...c:          Connection status when response was completed.
                    'X' = connection aborted before the response completed.
                    '+' = connection may be kept alive after the response is sent.
                    '-' = connection will be closed after the response is sent.
    %...{FOOBAR}e:  The contents of the environment variable FOOBAR
    %...f:          Filename
    %...h:          Remote host
    %...H           The request protocol
    %...{Foobar}i:  The contents of Foobar: header line(s) in the request
                    sent to the server.
    %...l:          Remote logname (from identd, if supplied)
    %...m           The request method
    %...{Foobar}n:  The contents of note Foobar from another module.
    %...{Foobar}o:  The contents of Foobar: header line(s) in the reply.
    %...p:          The canonical Port of the server serving the request
    %...P:          The process ID of the child that serviced the request.
    %...q           The query string (prepended with a ? if a query string exists,
                    otherwise an empty string)
    %...r:          First line of request
    %...s:          Status.  For requests that got internally redirected, this is
                    the status of the *original* request --- %...>s for the last.
    %...t:          Time, in common log format time format (standard english format)
    %...{format}t:  The time, in the form given by format, which should
                    be in strftime(3) format. (potentially localized)
    %...T:          The time taken to serve the request, in seconds.
    %...u:          Remote user (from auth; may be bogus if return status (%s) is 401)
    %...U:          The URL path requested, not including any query string.
    %...v:          The canonical ServerName of the server serving the request.
    %...V:          The server name according to the UseCanonicalName setting.

Class protocol:

 clfFormatString

Common Log Format (CLF)

 defaultFormatString

default is the NCSA Common Log Format

 ncsaFormatString

NCSA extended/combined log format

 settingsApplication

Instance protocol:

 formatString

 formatString: aString

Modified (format): / 29-11-2017 / 11:18:58 / cg

 logAccessFrom: aRequest to: aStreamOrFilename

aStreamOrFilename notNil logging to aStreamOrFilename otherwise
log to instVar logFile

 changeFromRequest: aRequest

Superclass says that I am responsible to implement this method

 inputFieldsForRequest: aRequest

Superclass says that I am responsible to implement this method

 log: aRequest on: outputStream

 performBackSlashFor: formatStream outStream: outStream request: aRequest

 performPercentDirectiveFor: formatStream outStream: outStream request: aRequest

The contents of the environment variable FOOBAR