proxy/logging/LogPredefined.cc

/** @file

  This file implements predefined log formats

  @section license License

  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you 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

  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 "LogObject.h"
#include "LogConfig.h"
#include "LogFormat.h"
#include "LogPredefined.h"

// predefined formats
const char * const PreDefinedFormatInfo::squid =
  "%<cqtq> %<ttms> %<chi> %<crc>/%<pssc> %<psql> %<cqhm> %<cquc> %<caun> %<phr>/%<pqsn> %<psct> %<xid>";

const char * const PreDefinedFormatInfo::common =
  "%<chi> - %<caun> [%<cqtn>] \"%<cqtx>\" %<pssc> %<pscl>";

const char * const PreDefinedFormatInfo::extended =
  "%<chi> - %<caun> [%<cqtn>] \"%<cqtx>\" %<pssc> %<pscl> "
  "%<sssc> %<sscl> %<cqbl> %<pqbl> %<cqhl> %<pshl> %<pqhl> %<sshl> %<tts>";

const char * const PreDefinedFormatInfo::extended2 =
  "%<chi> - %<caun> [%<cqtn>] \"%<cqtx>\" %<pssc> %<pscl> "
  "%<sssc> %<sscl> %<cqbl> %<pqbl> %<cqhl> %<pshl> %<pqhl> %<sshl> %<tts> %<phr> %<cfsc> %<pfsc> %<crc>";

PreDefinedFormatInfo *
MakePredefinedErrorLog(LogConfig * config)
{
  LogFormat * fmt;

  fmt = MakeTextLogFormat("error");
  config->global_format_list.add(fmt, false);

  // The error log is always ASCII, and currently does not work correctly with log collation.
  return NEW(new PreDefinedFormatInfo(fmt, "error.log", NULL /* no log header */, LOG_FILE_ASCII, false));
}

PreDefinedFormatList::PreDefinedFormatList()
{
}

PreDefinedFormatList::~PreDefinedFormatList()
{
  PreDefinedFormatInfo * info;
  while (!this->formats.empty()) {
    info = this->formats.pop();
    delete info;
  }
}

void
PreDefinedFormatList::init(LogConfig * config)
{
  LogFormat * fmt;

  // All these predefined formats work with log collation. They are optionally binary or ASCII, each
  // with a different config option.
#define make_format(is_ascii)  ((is_ascii) ? LOG_FILE_ASCII : LOG_FILE_BINARY )

  fmt = NEW(new LogFormat("squid", PreDefinedFormatInfo::squid));
  config->global_format_list.add(fmt, false);
  Debug("log", "squid format added to the global format list");

  if (config->squid_log_enabled) {
    this->formats.enqueue(NEW(new PreDefinedFormatInfo(fmt, config->squid_log_name, config->squid_log_header, make_format(config->squid_log_is_ascii), true)));
  }

  fmt = NEW(new LogFormat("common", PreDefinedFormatInfo::common));
  config->global_format_list.add(fmt, false);
  Debug("log", "common format added to the global format list");

  if (config->common_log_enabled) {
    this->formats.enqueue(NEW(new PreDefinedFormatInfo(fmt, config->common_log_name, config->common_log_header, make_format(config->common_log_is_ascii), true)));
  }

  fmt = NEW(new LogFormat("extended", PreDefinedFormatInfo::extended));
  config->global_format_list.add(fmt, false);
  Debug("log", "extended format added to the global format list");

  if (config->extended_log_enabled) {
    this->formats.enqueue(NEW(new PreDefinedFormatInfo(fmt, config->extended_log_name, config->extended_log_header, make_format(config->extended_log_is_ascii), true)));
  }

  fmt = NEW(new LogFormat("extended2", PreDefinedFormatInfo::extended2));
  config->global_format_list.add(fmt, false);
  Debug("log", "extended2 format added to the global format list");

  if (config->extended2_log_enabled) {
    this->formats.enqueue(NEW(new PreDefinedFormatInfo(fmt, config->extended2_log_name, config->extended2_log_header, make_format(config->extended2_log_is_ascii), true)));
  }

#undef make_format
}