proxy/http/HttpTransactCache.h

/** @file

  A brief file description

  @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.
 */

/****************************************************************************

   HttpTransactCache.h --
   Created On      : Thu Mar 26 17:19:35 1998


 ****************************************************************************/
#if !defined (_HttpTransactCache_h_)
#define _HttpTransactCache_h_

#include "libts.h"

struct CacheHTTPInfoVector;

class CacheLookupHttpConfig
{
public:
  bool cache_global_user_agent_header;  // 'global' user agent flag (don't need to marshal/unmarshal)
  bool cache_enable_default_vary_headers;
  bool ignore_accept_mismatch;
  bool ignore_accept_language_mismatch;
  bool ignore_accept_encoding_mismatch;
  bool ignore_accept_charset_mismatch;
  char *cache_vary_default_text;
  char *cache_vary_default_images;
  char *cache_vary_default_other;

  inkcoreapi int marshal_length();
  inkcoreapi int marshal(char *buf, int length);
  int unmarshal(Arena * arena, const char *buf, int length);

  CacheLookupHttpConfig():
    cache_global_user_agent_header(false),
    cache_enable_default_vary_headers(false),
    ignore_accept_mismatch(false),
    ignore_accept_language_mismatch(false),
    ignore_accept_encoding_mismatch(false),
    ignore_accept_charset_mismatch(false),
    cache_vary_default_text(NULL), cache_vary_default_images(NULL), cache_vary_default_other(NULL)
  { }

  void *operator new(size_t size, void *mem);
  void operator delete(void *mem);
};

extern ClassAllocator<CacheLookupHttpConfig> CacheLookupHttpConfigAllocator;
// this is a global CacheLookupHttpConfig used to bypass SelectFromAlternates
extern CacheLookupHttpConfig global_cache_lookup_config;

inline void *
CacheLookupHttpConfig::operator new(size_t size, void *mem)
{
  (void) size;
  return mem;
}

inline void
CacheLookupHttpConfig::operator delete(void *mem)
{
  CacheLookupHttpConfigAllocator.free((CacheLookupHttpConfig *) mem);
}

enum Variability_t
{
  VARIABILITY_NONE = 0,
  VARIABILITY_SOME,
  VARIABILITY_ALL
};

enum ContentEncoding
{
  NO_GZIP = 0,
  GZIP
};


class HttpTransactCache
{
public:

  /////////////////////////////////
  // content negotiation support //
  /////////////////////////////////

  static int SelectFromAlternates(CacheHTTPInfoVector * cache_vector_data,
                                  HTTPHdr * client_request, CacheLookupHttpConfig * cache_lookup_http_config_params);

  static float calculate_quality_of_match(CacheLookupHttpConfig * http_config_params, HTTPHdr * client_request, // in
                                          HTTPHdr * obj_client_request, // in
                                          HTTPHdr * obj_origin_server_response);        // in

  static float calculate_quality_of_accept_match(MIMEField * accept_field, MIMEField * content_field);

  static float calculate_quality_of_accept_charset_match(MIMEField * accept_field,
                                                         MIMEField * content_field,
                                                         MIMEField * cached_accept_field = NULL);

  static float calculate_quality_of_accept_encoding_match(MIMEField * accept_field,
                                                          MIMEField * content_field,
                                                          MIMEField * cached_accept_field = NULL);
  static ContentEncoding match_gzip(MIMEField * accept_field);

  static float calculate_quality_of_accept_language_match(MIMEField * accept_field,
                                                          MIMEField * content_field,
                                                          MIMEField * cached_accept_field = NULL);

  ///////////////////////////////////////////////
  // variability & server negotiation routines //
  ///////////////////////////////////////////////

  static Variability_t CalcVariability(CacheLookupHttpConfig * http_config_params, HTTPHdr * client_request,    // in
                                       HTTPHdr * obj_client_request,    // in
                                       HTTPHdr * obj_origin_server_response     // in
    );

  static HTTPStatus match_response_to_request_conditionals(HTTPHdr * ua_request, HTTPHdr * c_response);

};

#endif