src/adaptation/ecap/Host.cc

   1 /*
   2  * DEBUG: section 93    eCAP Interface
   3  */
   4 #include "squid.h"
   5 #include <libecap/adapter/service.h>
   6 #include <libecap/common/names.h>
   7 #include <libecap/common/registry.h>
   8 #include "base/TextException.h"
   9 #include "adaptation/ecap/ServiceRep.h"
  10 #include "adaptation/ecap/Host.h"
  11 #include "adaptation/ecap/MessageRep.h"
  12 #include "HttpRequest.h"
  13 #include "HttpReply.h"
  14
  15 const libecap::Name Adaptation::Ecap::protocolInternal("internal", libecap::Name::NextId());
  16 const libecap::Name Adaptation::Ecap::protocolCacheObj("cache_object", libecap::Name::NextId());
  17 const libecap::Name Adaptation::Ecap::protocolIcp("ICP", libecap::Name::NextId());
  18 #if USE_HTCP
  19 const libecap::Name Adaptation::Ecap::protocolHtcp("Htcp", libecap::Name::NextId());
  20 #endif
  21 const libecap::Name Adaptation::Ecap::protocolIcy("ICY", libecap::Name::NextId());
  22 const libecap::Name Adaptation::Ecap::protocolUnknown("_unknown_", libecap::Name::NextId());
  23
  24 const libecap::Name Adaptation::Ecap::metaBypassable("bypassable", libecap::Name::NextId());
  25
  26 /// the host application (i.e., Squid) wrapper registered with libecap
  27 static libecap::shared_ptr<Adaptation::Ecap::Host> TheHost;
  28
  29 Adaptation::Ecap::Host::Host()
  30 {
  31     // assign our host-specific IDs to well-known names
  32     // this code can run only once
  33
  34     libecap::headerTransferEncoding.assignHostId(HDR_TRANSFER_ENCODING);
  35     libecap::headerReferer.assignHostId(HDR_REFERER);
  36     libecap::headerContentLength.assignHostId(HDR_CONTENT_LENGTH);
  37     libecap::headerVia.assignHostId(HDR_VIA);
  38     // TODO: libecap::headerXClientIp.assignHostId(HDR_X_CLIENT_IP);
  39     // TODO: libecap::headerXServerIp.assignHostId(HDR_X_SERVER_IP);
  40
  41     libecap::protocolHttp.assignHostId(AnyP::PROTO_HTTP);
  42     libecap::protocolHttps.assignHostId(AnyP::PROTO_HTTPS);
  43     libecap::protocolFtp.assignHostId(AnyP::PROTO_FTP);
  44     libecap::protocolGopher.assignHostId(AnyP::PROTO_GOPHER);
  45     libecap::protocolWais.assignHostId(AnyP::PROTO_WAIS);
  46     libecap::protocolUrn.assignHostId(AnyP::PROTO_URN);
  47     libecap::protocolWhois.assignHostId(AnyP::PROTO_WHOIS);
  48     protocolInternal.assignHostId(AnyP::PROTO_INTERNAL);
  49     protocolCacheObj.assignHostId(AnyP::PROTO_CACHE_OBJECT);
  50     protocolIcp.assignHostId(AnyP::PROTO_ICP);
  51 #if USE_HTCP
  52     protocolHtcp.assignHostId(AnyP::PROTO_HTCP);
  53 #endif
  54     protocolIcy.assignHostId(AnyP::PROTO_ICY);
  55     protocolUnknown.assignHostId(AnyP::PROTO_UNKNOWN);
  56
  57     // allows adapter to safely ignore this in adapter::Service::configure()
  58     metaBypassable.assignHostId(1);
  59 }
  60
  61 std::string
  62 Adaptation::Ecap::Host::uri() const
  63 {
  64     return "ecap://squid-cache.org/ecap/hosts/squid";
  65 }
  66
  67 void
  68 Adaptation::Ecap::Host::describe(std::ostream &os) const
  69 {
  70     os << PACKAGE_NAME << " v" << PACKAGE_VERSION;
  71 }
  72
  73 void
  74 Adaptation::Ecap::Host::noteService(const libecap::weak_ptr<libecap::adapter::Service> &weak)
  75 {
  76     Must(!weak.expired());
  77     RegisterAdapterService(weak.lock());
  78 }
  79
  80 static int
  81 SquidLogLevel(libecap::LogVerbosity lv)
  82 {
  83     if (lv.critical())
  84         return DBG_CRITICAL; // is it a good idea to ignore other flags?
  85
  86     if (lv.large())
  87         return DBG_DATA; // is it a good idea to ignore other flags?
  88
  89     if (lv.application())
  90         return DBG_IMPORTANT; // is it a good idea to ignore other flags?
  91
  92     return 2 + 2*lv.debugging() + 3*lv.operation() + 2*lv.xaction();
  93 }
  94
  95 std::ostream *
  96 Adaptation::Ecap::Host::openDebug(libecap::LogVerbosity lv)
  97 {
  98     const int squidLevel = SquidLogLevel(lv);
  99     const int squidSection = 93; // XXX: this should be a global constant
 100     // XXX: Debug.h should provide this to us
 101     if ((Debug::level = squidLevel) <= Debug::Levels[squidSection])
 102         return &Debug::getDebugOut();
 103     else
 104         return NULL;
 105 }
 106
 107 void
 108 Adaptation::Ecap::Host::closeDebug(std::ostream *debug)
 109 {
 110     if (debug)
 111         Debug::finishDebug();
 112 }
 113
 114 Adaptation::Ecap::Host::MessagePtr
 115 Adaptation::Ecap::Host::newRequest() const
 116 {
 117     return MessagePtr(new Adaptation::Ecap::MessageRep(new HttpRequest));
 118 }
 119
 120 Adaptation::Ecap::Host::MessagePtr
 121 Adaptation::Ecap::Host::newResponse() const
 122 {
 123     return MessagePtr(new Adaptation::Ecap::MessageRep(new HttpReply));
 124 }
 125
 126 void
 127 Adaptation::Ecap::Host::Register()
 128 {
 129     if (!TheHost) {
 130         TheHost.reset(new Adaptation::Ecap::Host);
 131         libecap::RegisterHost(TheHost);
 132     }
 133 }