plugins/experimental/cache_fill/configs.cc

/** @file

    Plugin to perform background fetches of certain content that would
    otherwise not be cached. For example, Range: requests / responses.

    @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 <getopt.h>
#include <cstdio>
#include <memory.h>

#include "configs.h"
#include "background_fetch.h"

#include <swoc/TextView.h>
#include <swoc/swoc_file.h>
#include <tsutil/ts_bw_format.h>

using namespace swoc::literals;

// Parse the command line options. This got a little wonky, since we decided to have different
// syntax for remap vs global plugin initialization, and the global BG fetch state :-/. Clean up
// later...
bool
BgFetchConfig::parseOptions(int argc, const char *argv[])
{
  static const struct option longopt[] = {
    {const_cast<char *>("log"),             required_argument, nullptr, 'l' },
    {const_cast<char *>("config"),          required_argument, nullptr, 'c' },
    {const_cast<char *>("range-req-only"),  optional_argument, nullptr, 'r' },
    {const_cast<char *>("cache-range-req"), optional_argument, nullptr, 'a' },
    {nullptr,                               no_argument,       nullptr, '\0'},
  };

  while (true) {
    int opt = getopt_long(argc, const_cast<char *const *>(argv), "", longopt, nullptr);

    if (opt == -1) {
      break;
    }
    switch (opt) {
    case 'l':
      Dbg(dbg_ctl, "option: log file specified: %s", optarg);
      _log_file = optarg;
      break;
    case 'c':
      Dbg(dbg_ctl, "option: config file '%s'", optarg);
      if (!readConfig(optarg)) {
        // Error messages are written in the parser
        return false;
      }
      break;
    case 'r':
      Dbg(dbg_ctl, "option: --range-req-only set");
      _range_req_only = isTrue(optarg);
      break;
    case 'a':
      Dbg(dbg_ctl, "option: --cache-range-req set");
      _cache_range_req = isTrue(optarg);
      break;
    default:
      TSError("[%s] invalid plugin option: %c", PLUGIN_NAME, opt);
      return false;
      break;
    }
  }

  if (_range_req_only && !_cache_range_req) {
    TSError("[%s] Cannot define _range_req_only=true and _cache_range_req=false", PLUGIN_NAME);
    return false;
  }

  return true;
}

// Read a config file, populate the linked list (chain the BgFetchRule's)
bool
BgFetchConfig::readConfig(const char *config_file)
{
  if (nullptr == config_file) {
    TSError("[%s] invalid config file", PLUGIN_NAME);
    return false;
  }

  swoc::file::path path(config_file);

  Dbg(dbg_ctl, "trying to open config file in this path: %s", config_file);

  if (!path.is_absolute()) {
    path = swoc::file::path(TSConfigDirGet()) / path;
  }
  Dbg(dbg_ctl, "chosen config file is at: %s", path.c_str());

  std::error_code ec;
  auto            content = swoc::file::load(path, ec);
  if (ec) {
    swoc::bwprint(ts::bw_dbg, "[{}] invalid config file: {} {}", PLUGIN_NAME, path, ec);
    TSError("%s", ts::bw_dbg.c_str());
    Dbg(dbg_ctl, "%s", ts::bw_dbg.c_str());
    return false;
  }

  swoc::TextView text{content};
  while (text) {
    auto line = text.take_prefix_at('\n').ltrim_if(&isspace);

    if (line.empty() || line.front() == '#') {
      continue;
    }

    auto cfg_type = line.take_prefix_if(&isspace);
    if (cfg_type.empty()) {
      continue;
    }

    Dbg(dbg_ctl, "setting background_fetch exclusion criterion based on string: %.*s", int(cfg_type.size()), cfg_type.data());

    bool exclude = false;
    if (0 == strcasecmp(cfg_type, "exclude")) {
      exclude = true;
    } else if (0 != strcasecmp(cfg_type, "include")) {
      swoc::bwprint(ts::bw_dbg, "[{}] invalid specifier {}, skipping config line", PLUGIN_NAME, cfg_type);
      TSError("%s", ts::bw_dbg.c_str());
      continue;
    }

    if (auto cfg_name = line.take_prefix_if(&isspace); !cfg_name.empty()) {
      if (auto cfg_value = line.take_prefix_if(&isspace); !cfg_value.empty()) {
        if ("Client-IP"_tv == cfg_name) {
          swoc::IPRange r;
          // '*' is special - match any address. Signalled by empty range.
          if (cfg_value.size() != 1 || cfg_value.front() != '*') {
            if (!r.load(cfg_value)) { // assume if it loads, it's not empty.
              TSError("[%s] invalid IP address range %.*s, skipping config value", PLUGIN_NAME, int(cfg_value.size()),
                      cfg_value.data());
              continue;
            }
          }
          _rules.emplace_back(exclude, r);
          swoc::bwprint(ts::bw_dbg, "adding background_fetch address range rule {} for {}: {}", exclude, cfg_name, cfg_value);
          Dbg(dbg_ctl, "%s", ts::bw_dbg.c_str());
        } else if ("Content-Length"_tv == cfg_name) {
          BgFetchRule::size_cmp_type::OP op{BgFetchRule::size_cmp_type::LESS_THAN_OR_EQUAL};
          if (cfg_value[0] == '<') {
            op = BgFetchRule::size_cmp_type::LESS_THAN_OR_EQUAL;
          } else if (cfg_value[0] == '>') {
            op = BgFetchRule::size_cmp_type::GREATER_THAN_OR_EQUAL;
          } else {
            TSError("[%s] invalid Content-Length condition %.*s, skipping config value", PLUGIN_NAME, int(cfg_value.size()),
                    cfg_value.data());
            continue;
          }
          ++cfg_value; // Drop leading character.
          if (cfg_value.empty()) {
            TSError("[%s] missing Content-Length size value, skipping config value", PLUGIN_NAME);
            continue;
          }
          swoc::TextView parsed;
          auto           n = swoc::svtou(cfg_value, &parsed);
          if (parsed.size() != cfg_value.size()) {
            TSError("[%s] invalid Content-Length size value %.*s, skipping config value", PLUGIN_NAME, int(cfg_value.size()),
                    cfg_value.data());
            continue;
          }
          _rules.emplace_back(exclude, op, size_t(n));

          swoc::bwprint(ts::bw_dbg, "adding background_fetch content length rule {} for {}: {}", exclude, cfg_name, cfg_value);
          Dbg(dbg_ctl, "%s", ts::bw_dbg.c_str());
        } else {
          _rules.emplace_back(exclude, cfg_name, cfg_value);
          swoc::bwprint(ts::bw_dbg, "adding background_fetch field compare rule {} for {}: {}", exclude, cfg_name, cfg_value);
          Dbg(dbg_ctl, "%s", ts::bw_dbg.c_str());
        }
      } else {
        TSError("[%s] invalid value %.*s, skipping config line", PLUGIN_NAME, int(cfg_name.size()), cfg_name.data());
      }
    }
  }

  Dbg(dbg_ctl, "Done parsing config");

  return true;
}

///////////////////////////////////////////////////////////////////////////
// Check the configuration (either per remap, or global), and decide if
// this request is allowed to trigger a background fetch.
//
bool
BgFetchConfig::bgFetchAllowed(TSHttpTxn txnp) const
{
  Dbg(dbg_ctl, "Testing: request is internal?");
  if (TSHttpTxnIsInternal(txnp)) {
    return false;
  }

  if (_range_req_only || !_cache_range_req) {
    TSMBuffer bufp;
    TSMLoc    hdr_loc;
    if (TSHttpTxnClientReqGet(txnp, &bufp, &hdr_loc) == TS_SUCCESS) {
      bool hasRangeHdrs = false;
      for (auto const &header : FILTER_HEADERS) {
        TSMLoc field_loc = TSMimeHdrFieldFind(bufp, hdr_loc, header.data(), static_cast<int>(header.size()));
        if (field_loc != TS_NULL_MLOC) {
          TSHandleMLocRelease(bufp, hdr_loc, field_loc);
          hasRangeHdrs = true;
          break;
        }
      }
      TSHandleMLocRelease(bufp, TS_NULL_MLOC, hdr_loc);
      if (!hasRangeHdrs && _range_req_only) {
        Dbg(dbg_ctl, "_range_req_only=true; This transaction is not a range request");
        return false;
      }
      if (hasRangeHdrs && !_cache_range_req) {
        Dbg(dbg_ctl, "_cache_range_req=false; This transaction is a range request");
        return false;
      }
    }
  }

  bool allow_bg_fetch = true;
  // We could do this recursively, but following the linked list is probably more efficient.
  for (auto const &r : _rules) {
    if (r.check_field_configured(txnp)) {
      Dbg(dbg_ctl, "found %s rule match", r._exclude ? "exclude" : "include");
      allow_bg_fetch = !r._exclude;
      break;
    }
  }

  return allow_bg_fetch;
}