src/ESIInclude.h

   1 /*
   2  * $Id$
   3  *
   4  * DEBUG: section 86    ESI processing
   5  * AUTHOR: Robert Collins
   6  *
   7  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   8  * ----------------------------------------------------------
   9  *
  10  *  Squid is the result of efforts by numerous individuals from
  11  *  the Internet community; see the CONTRIBUTORS file for full
  12  *  details.   Many organizations have provided support for Squid's
  13  *  development; see the SPONSORS file for full details.  Squid is
  14  *  Copyrighted (C) 2001 by the Regents of the University of
  15  *  California; see the COPYRIGHT file for full details.  Squid
  16  *  incorporates software developed and/or copyrighted by other
  17  *  sources; see the CREDITS file for full details.
  18  *
  19  *  This program is free software; you can redistribute it and/or modify
  20  *  it under the terms of the GNU General Public License as published by
  21  *  the Free Software Foundation; either version 2 of the License, or
  22  *  (at your option) any later version.
  23  *
  24  *  This program is distributed in the hope that it will be useful,
  25  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  *  GNU General Public License for more details.
  28  *
  29  *  You should have received a copy of the GNU General Public License
  30  *  along with this program; if not, write to the Free Software
  31  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  32  *
  33  * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
  34  */
  35
  36 #ifndef SQUID_ESIINCLUDE_H
  37 #define SQUID_ESIINCLUDE_H
  38
  39 #include "squid.h"
  40 #include "ESISegment.h"
  41 #include "ESIElement.h"
  42 #include "ESIContext.h"
  43
  44 class ESIInclude;
  45 typedef RefCount<ESIInclude> ESIIncludePtr;
  46
  47 class ESIStreamContext : public RefCountable
  48 {
  49
  50 public:
  51     typedef RefCount<ESIStreamContext> Pointer;
  52     void *operator new(size_t);
  53     void operator delete(void *);
  54     ESIStreamContext();
  55     ~ESIStreamContext();
  56     void freeResources();
  57     int finished;
  58     ESIIncludePtr include;
  59     ESISegment::Pointer localbuffer;
  60     ESISegment::Pointer buffer;
  61
  62 private:
  63     CBDATA_CLASS(ESIStreamContext);
  64 };
  65
  66 /* ESIInclude */
  67
  68 class ESIInclude : public ESIElement
  69 {
  70
  71 public:
  72     MEMPROXY_CLASS(ESIInclude);
  73
  74     ESIInclude(esiTreeParentPtr, int attributes, const char **attr, ESIContext *);
  75     ~ESIInclude();
  76     void render(ESISegment::Pointer);
  77     esiProcessResult_t process (int dovars);
  78     Pointer makeCacheable() const;
  79     Pointer makeUsable(esiTreeParentPtr, ESIVarState &) const;
  80     void subRequestDone (ESIStreamContext::Pointer, bool);
  81
  82     struct {
  83         int onerrorcontinue:1; /* on error return zero data */
  84         int failed:1; /* Failed to process completely */
  85         int finished:1; /* Finished getting subrequest data */
  86     } flags;
  87     ESIStreamContext::Pointer src;
  88     ESIStreamContext::Pointer alt;
  89     ESISegment::Pointer srccontent;
  90     ESISegment::Pointer altcontent;
  91     ESIVarState *varState;
  92     char *srcurl, *alturl;
  93     void fail(ESIStreamContext::Pointer);
  94     void finish();
  95
  96 private:
  97     void Start (ESIStreamContext::Pointer, char const *, ESIVarState *);
  98     esiTreeParentPtr parent;
  99     void start();
 100     bool started;
 101     bool sent;
 102     ESIInclude(ESIInclude const &);
 103     bool dataNeeded() const;
 104     void prepareRequestHeaders(HttpHeader &tempheaders, ESIVarState *vars);
 105 };
 106
 107 MEMPROXY_CLASS_INLINE(ESIInclude)          /**DOCS_NOSEMI*/
 108
 109 #endif /* SQUID_ESIINCLUDE_H */