842ae4bd224140319ae7feec1872b93dfd491143fielding/* Licensed to the Apache Software Foundation (ASF) under one or more
842ae4bd224140319ae7feec1872b93dfd491143fielding * contributor license agreements. See the NOTICE file distributed with
842ae4bd224140319ae7feec1872b93dfd491143fielding * this work for additional information regarding copyright ownership.
842ae4bd224140319ae7feec1872b93dfd491143fielding * The ASF licenses this file to You under the Apache License, Version 2.0
842ae4bd224140319ae7feec1872b93dfd491143fielding * (the "License"); you may not use this file except in compliance with
842ae4bd224140319ae7feec1872b93dfd491143fielding * the License. You may obtain a copy of the License at
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet *
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * http://www.apache.org/licenses/LICENSE-2.0
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet *
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * Unless required by applicable law or agreed to in writing, software
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * distributed under the License is distributed on an "AS IS" BASIS,
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * See the License for the specific language governing permissions and
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * limitations under the License.
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet */
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet
ab5581cc78e9d865b0a6ab1404c53347b3276968rbb#include "httpd.h"
024cd9589e52cf11ce765dfddb5b5f0c6e421a48gstein#include "http_log.h"
024cd9589e52cf11ce765dfddb5b5f0c6e421a48gstein#include "http_request.h"
024cd9589e52cf11ce765dfddb5b5f0c6e421a48gstein#include "http_config.h"
024cd9589e52cf11ce765dfddb5b5f0c6e421a48gstein#include "http_protocol.h"
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb#include "mod_status.h"
2d71630471d1c23f0137309e3c3957c633ecbfd6rbb
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet#include "apr_strings.h"
e5c43448cda8c78e3d0cd8683aab2c907cc38362rpluem#include "apr_time.h"
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet
89211a3153be8b03353c3bfbca45fed67cb80f0bpquerna#include "ap_socache.h"
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet#include "distcache/dc_client.h"
b501b72e4bfed12a431278217ba66ae531d9a293rbb
024cd9589e52cf11ce765dfddb5b5f0c6e421a48gstein#if !defined(DISTCACHE_CLIENT_API) || (DISTCACHE_CLIENT_API < 0x0001)
a742cbb3e85669473b3233f30e3978bb6a20083cylavic#error "You must compile with a more recent version of the distcache-base package"
a742cbb3e85669473b3233f30e3978bb6a20083cylavic#endif
a742cbb3e85669473b3233f30e3978bb6a20083cylavic
a742cbb3e85669473b3233f30e3978bb6a20083cylavicstruct ap_socache_instance_t {
a742cbb3e85669473b3233f30e3978bb6a20083cylavic /* Configured target server: */
9591ec71b8911ecefbf6571333ff78fcb6efffa5jorton const char *target;
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna /* distcache client context: */
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna DC_CTX *dc;
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna};
7184de27ec1d62a83c41cdeac0953ca9fd661e8csf
7184de27ec1d62a83c41cdeac0953ca9fd661e8csfstatic const char *socache_dc_create(ap_socache_instance_t **context,
7184de27ec1d62a83c41cdeac0953ca9fd661e8csf const char *arg,
36ef8f77bffe75d1aa327882be1b5bdbe2ff567asf apr_pool_t *tmp, apr_pool_t *p)
e8fcc872d5caeea36adb6511f9d1ab6ce3fbb5c0jerenkrantz{
2261031aa94be82d7e6b1b8c367afc1b282317f5ianh struct ap_socache_instance_t *ctx;
a742cbb3e85669473b3233f30e3978bb6a20083cylavic
a742cbb3e85669473b3233f30e3978bb6a20083cylavic ctx = *context = apr_palloc(p, sizeof *ctx);
a742cbb3e85669473b3233f30e3978bb6a20083cylavic
a742cbb3e85669473b3233f30e3978bb6a20083cylavic ctx->target = apr_pstrdup(p, arg);
a742cbb3e85669473b3233f30e3978bb6a20083cylavic
a742cbb3e85669473b3233f30e3978bb6a20083cylavic return NULL;
a742cbb3e85669473b3233f30e3978bb6a20083cylavic}
a742cbb3e85669473b3233f30e3978bb6a20083cylavic
a742cbb3e85669473b3233f30e3978bb6a20083cylavicstatic apr_status_t socache_dc_init(ap_socache_instance_t *ctx,
a742cbb3e85669473b3233f30e3978bb6a20083cylavic const char *namespace,
a742cbb3e85669473b3233f30e3978bb6a20083cylavic const struct ap_socache_hints *hints,
a742cbb3e85669473b3233f30e3978bb6a20083cylavic server_rec *s, apr_pool_t *p)
a742cbb3e85669473b3233f30e3978bb6a20083cylavic{
3c990331fc6702119e4f5b8ba9eae3021aea5265jim#if 0
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet /* If a "persistent connection" mode of operation is preferred, you *must*
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet * also use the PIDCHECK flag to ensure fork()'d processes don't interlace
a742cbb3e85669473b3233f30e3978bb6a20083cylavic * comms on the same connection as each other. */
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet#define SESSION_CTX_FLAGS SESSION_CTX_FLAG_PERSISTENT | \
275419d6395e6f072962fb701b89accaff1f3690jerenkrantz SESSION_CTX_FLAG_PERSISTENT_PIDCHECK | \
9591ec71b8911ecefbf6571333ff78fcb6efffa5jorton SESSION_CTX_FLAG_PERSISTENT_RETRY | \
de9479d1589cb756c9517611d8d193466536107bjkaluza SESSION_CTX_FLAG_PERSISTENT_LATE
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna#else
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet /* This mode of operation will open a temporary connection to the 'target'
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet * for each cache operation - this makes it safe against fork()
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna * automatically. This mode is preferred when running a local proxy (over
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet * unix domain sockets) because overhead is negligable and it reduces the
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm * performance/stability danger of file-descriptor bloatage. */
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet#define SESSION_CTX_FLAGS 0
95d00ea81131488769296fa5765ed745cbf45207trawick#endif
95d00ea81131488769296fa5765ed745cbf45207trawick ctx->dc = DC_CTX_new(ctx->target, SESSION_CTX_FLAGS);
95d00ea81131488769296fa5765ed745cbf45207trawick if (!ctx->dc) {
95d00ea81131488769296fa5765ed745cbf45207trawick ap_log_error(APLOG_MARK, APLOG_ERR, 0, s, APLOGNO(00738) "distributed scache failed to obtain context");
95d00ea81131488769296fa5765ed745cbf45207trawick return APR_EGENERAL;
95d00ea81131488769296fa5765ed745cbf45207trawick }
95d00ea81131488769296fa5765ed745cbf45207trawick ap_log_error(APLOG_MARK, APLOG_INFO, 0, s, APLOGNO(00739) "distributed scache context initialised");
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm
db6d6970c955ef03a17d96a388b10ca2eb81e924trawick return APR_SUCCESS;
85e4da1cf0dee899551b583b1f06314b2835100awrowe}
9179fa90e821c964d10f28b97fc6acee776af7cfwrowe
ebf4099fd4921bbbcef21dc872b9cd4fc73e9f55trawickstatic void socache_dc_destroy(ap_socache_instance_t *ctx, server_rec *s)
185aa71728867671e105178b4c66fbc22b65ae26sf{
9179fa90e821c964d10f28b97fc6acee776af7cfwrowe if (ctx && ctx->dc) {
2261031aa94be82d7e6b1b8c367afc1b282317f5ianh DC_CTX_free(ctx->dc);
ebf4099fd4921bbbcef21dc872b9cd4fc73e9f55trawick ctx->dc = NULL;
ebf4099fd4921bbbcef21dc872b9cd4fc73e9f55trawick }
ebf4099fd4921bbbcef21dc872b9cd4fc73e9f55trawick}
85e4da1cf0dee899551b583b1f06314b2835100awrowe
2261031aa94be82d7e6b1b8c367afc1b282317f5ianhstatic apr_status_t socache_dc_store(ap_socache_instance_t *ctx, server_rec *s,
9179fa90e821c964d10f28b97fc6acee776af7cfwrowe const unsigned char *id, unsigned int idlen,
ab5581cc78e9d865b0a6ab1404c53347b3276968rbb apr_time_t expiry,
185aa71728867671e105178b4c66fbc22b65ae26sf unsigned char *der, unsigned int der_len,
9179fa90e821c964d10f28b97fc6acee776af7cfwrowe apr_pool_t *p)
2261031aa94be82d7e6b1b8c367afc1b282317f5ianh{
cf24c48249f38c34c04617f5b78b240f1cee380ajerenkrantz /* !@#$%^ - why do we deal with *absolute* time anyway???
cf24c48249f38c34c04617f5b78b240f1cee380ajerenkrantz * Uhm - because most things expire things at a specific time?
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet * Were the API were thought out expiry - r->request_time is a good approximation
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet */
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet expiry -= apr_time_now();
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet /* Send the serialised session to the distributed cache context */
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet if (!DC_CTX_add_session(ctx->dc, id, idlen, der, der_len,
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet apr_time_msec(expiry))) {
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet ap_log_error(APLOG_MARK, APLOG_ERR, 0, s, APLOGNO(00740) "distributed scache 'store' failed");
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet return APR_EGENERAL;
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet }
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s, APLOGNO(00741) "distributed scache 'store' successful");
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet return APR_SUCCESS;
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet}
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudetstatic apr_status_t socache_dc_retrieve(ap_socache_instance_t *ctx, server_rec *s,
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet const unsigned char *id, unsigned int idlen,
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet unsigned char *dest, unsigned int *destlen,
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet apr_pool_t *p)
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet{
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet unsigned int data_len;
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet /* Retrieve any corresponding session from the distributed cache context */
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet if (!DC_CTX_get_session(ctx->dc, id, idlen, dest, *destlen, &data_len)) {
9179fa90e821c964d10f28b97fc6acee776af7cfwrowe ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s, APLOGNO(00742) "distributed scache 'retrieve' MISS");
ab5581cc78e9d865b0a6ab1404c53347b3276968rbb return APR_NOTFOUND;
185aa71728867671e105178b4c66fbc22b65ae26sf }
2261031aa94be82d7e6b1b8c367afc1b282317f5ianh if (data_len > *destlen) {
2261031aa94be82d7e6b1b8c367afc1b282317f5ianh ap_log_error(APLOG_MARK, APLOG_ERR, 0, s, APLOGNO(00743) "distributed scache 'retrieve' OVERFLOW");
2261031aa94be82d7e6b1b8c367afc1b282317f5ianh return APR_ENOSPC;
cf24c48249f38c34c04617f5b78b240f1cee380ajerenkrantz }
cf24c48249f38c34c04617f5b78b240f1cee380ajerenkrantz *destlen = data_len;
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s, APLOGNO(00744) "distributed scache 'retrieve' HIT");
275419d6395e6f072962fb701b89accaff1f3690jerenkrantz return APR_SUCCESS;
275419d6395e6f072962fb701b89accaff1f3690jerenkrantz}
275419d6395e6f072962fb701b89accaff1f3690jerenkrantz
185aa71728867671e105178b4c66fbc22b65ae26sfstatic apr_status_t socache_dc_remove(ap_socache_instance_t *ctx,
275419d6395e6f072962fb701b89accaff1f3690jerenkrantz server_rec *s, const unsigned char *id,
275419d6395e6f072962fb701b89accaff1f3690jerenkrantz unsigned int idlen, apr_pool_t *p)
275419d6395e6f072962fb701b89accaff1f3690jerenkrantz{
275419d6395e6f072962fb701b89accaff1f3690jerenkrantz /* Remove any corresponding session from the distributed cache context */
275419d6395e6f072962fb701b89accaff1f3690jerenkrantz if (!DC_CTX_remove_session(ctx->dc, id, idlen)) {
275419d6395e6f072962fb701b89accaff1f3690jerenkrantz ap_log_error(APLOG_MARK, APLOG_ERR, 0, s, APLOGNO(00745) "distributed scache 'remove' MISS");
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet return APR_NOTFOUND;
ca70ded17026ceeee35b52df57378476b8c1293btrawick }
b501b72e4bfed12a431278217ba66ae531d9a293rbb else {
b501b72e4bfed12a431278217ba66ae531d9a293rbb ap_log_error(APLOG_MARK, APLOG_ERR, 0, s, APLOGNO(00746) "distributed scache 'remove' HIT");
b501b72e4bfed12a431278217ba66ae531d9a293rbb return APR_SUCCESS;
a742cbb3e85669473b3233f30e3978bb6a20083cylavic }
a742cbb3e85669473b3233f30e3978bb6a20083cylavic}
a742cbb3e85669473b3233f30e3978bb6a20083cylavic
a742cbb3e85669473b3233f30e3978bb6a20083cylavicstatic void socache_dc_status(ap_socache_instance_t *ctx, request_rec *r, int flags)
a742cbb3e85669473b3233f30e3978bb6a20083cylavic{
a742cbb3e85669473b3233f30e3978bb6a20083cylavic ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, APLOGNO(00747)
a742cbb3e85669473b3233f30e3978bb6a20083cylavic "distributed scache 'socache_dc_status'");
a742cbb3e85669473b3233f30e3978bb6a20083cylavic if (!(flags & AP_STATUS_SHORT)) {
a742cbb3e85669473b3233f30e3978bb6a20083cylavic ap_rprintf(r, "cache type: <b>DC (Distributed Cache)</b>, "
a742cbb3e85669473b3233f30e3978bb6a20083cylavic " target: <b>%s</b><br>", ctx->target);
a742cbb3e85669473b3233f30e3978bb6a20083cylavic }
a742cbb3e85669473b3233f30e3978bb6a20083cylavic else {
a742cbb3e85669473b3233f30e3978bb6a20083cylavic ap_rputs("CacheType: DC\n", r);
a742cbb3e85669473b3233f30e3978bb6a20083cylavic ap_rvputs(r, "CacheTarget: ", ctx->target, "\n", NULL);
47985ff6a0ba93c3e25be3829e786bf958510dfdjim }
3c990331fc6702119e4f5b8ba9eae3021aea5265jim}
3c990331fc6702119e4f5b8ba9eae3021aea5265jim
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquernastatic apr_status_t socache_dc_iterate(ap_socache_instance_t *instance,
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna server_rec *s, void *userctx,
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna ap_socache_iterator_t *iterator,
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna apr_pool_t *pool)
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna{
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna return APR_ENOTIMPL;
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna}
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquernastatic const ap_socache_provider_t socache_dc = {
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna "distcache",
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna 0,
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna socache_dc_create,
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna socache_dc_init,
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna socache_dc_destroy,
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet socache_dc_store,
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna socache_dc_retrieve,
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna socache_dc_remove,
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna socache_dc_status,
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna socache_dc_iterate
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna};
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquernastatic void register_hooks(apr_pool_t *p)
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna{
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna ap_register_provider(p, AP_SOCACHE_PROVIDER_GROUP, "dc",
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna AP_SOCACHE_PROVIDER_VERSION,
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna &socache_dc);
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna}
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquernaAP_DECLARE_MODULE(socache_dc) = {
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna STANDARD20_MODULE_STUFF,
77e0c54d01cb01e700e939a78afa49a7aa1e2275pquerna NULL, NULL, NULL, NULL, NULL,
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet register_hooks
dc9d4f49d36e64c0157d930cb22ca82a6291c0cbdgaudet};
85e4da1cf0dee899551b583b1f06314b2835100awrowe
85e4da1cf0dee899551b583b1f06314b2835100awrowe