src/internal.cc

   1
   2 /*
   3  * $Id$
   4  *
   5  * DEBUG: section 76    Internal Squid Object handling
   6  * AUTHOR: Duane, Alex, Henrik
   7  *
   8  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   9  * ----------------------------------------------------------
  10  *
  11  *  Squid is the result of efforts by numerous individuals from
  12  *  the Internet community; see the CONTRIBUTORS file for full
  13  *  details.   Many organizations have provided support for Squid's
  14  *  development; see the SPONSORS file for full details.  Squid is
  15  *  Copyrighted (C) 2001 by the Regents of the University of
  16  *  California; see the COPYRIGHT file for full details.  Squid
  17  *  incorporates software developed and/or copyrighted by other
  18  *  sources; see the CREDITS file for full details.
  19  *
  20  *  This program is free software; you can redistribute it and/or modify
  21  *  it under the terms of the GNU General Public License as published by
  22  *  the Free Software Foundation; either version 2 of the License, or
  23  *  (at your option) any later version.
  24  *
  25  *  This program is distributed in the hope that it will be useful,
  26  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  *  GNU General Public License for more details.
  29  *
  30  *  You should have received a copy of the GNU General Public License
  31  *  along with this program; if not, write to the Free Software
  32  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  33  *
  34  */
  35
  36 #include "squid.h"
  37 #include "CacheManager.h"
  38 #include "comm/Connection.h"
  39 #include "errorpage.h"
  40 #include "icmp/net_db.h"
  41 #include "Store.h"
  42 #include "HttpRequest.h"
  43 #include "HttpReply.h"
  44 #include "MemBuf.h"
  45 #include "protos.h"
  46 #include "SquidTime.h"
  47 #include "tools.h"
  48 #include "URL.h"
  49 #include "wordlist.h"
  50
  51 /* called when we "miss" on an internal object;
  52  * generate known dynamic objects,
  53  * return HTTP_NOT_FOUND for others
  54  */
  55 void
  56 internalStart(const Comm::ConnectionPointer &clientConn, HttpRequest * request, StoreEntry * entry)
  57 {
  58     ErrorState *err;
  59     const char *upath = request->urlpath.termedBuf();
  60     debugs(76, 3, HERE << clientConn << " requesting '" << upath << "'");
  61
  62     if (0 == strcmp(upath, "/squid-internal-dynamic/netdb")) {
  63         netdbBinaryExchange(entry);
  64     } else if (0 == strcmp(upath, "/squid-internal-periodic/store_digest")) {
  65 #if USE_CACHE_DIGESTS
  66         const char *msgbuf = "This cache is currently building its digest.\n";
  67 #else
  68
  69         const char *msgbuf = "This cache does not support Cache Digests.\n";
  70 #endif
  71
  72         HttpReply *reply = new HttpReply;
  73         reply->setHeaders(HTTP_NOT_FOUND, "Not Found", "text/plain", strlen(msgbuf), squid_curtime, -2);
  74         entry->replaceHttpReply(reply);
  75         entry->append(msgbuf, strlen(msgbuf));
  76         entry->complete();
  77     } else if (0 == strncmp(upath, "/squid-internal-mgr/", 20)) {
  78         CacheManager::GetInstance()->Start(clientConn, request, entry);
  79     } else {
  80         debugObj(76, 1, "internalStart: unknown request:\n",
  81                  request, (ObjPackMethod) & httpRequestPack);
  82         err = new ErrorState(ERR_INVALID_REQ, HTTP_NOT_FOUND, request);
  83         errorAppendEntry(entry, err);
  84     }
  85 }
  86
  87 int
  88 internalCheck(const char *urlpath)
  89 {
  90     return (0 == strncmp(urlpath, "/squid-internal-", 16));
  91 }
  92
  93 int
  94 internalStaticCheck(const char *urlpath)
  95 {
  96     return (0 == strncmp(urlpath, "/squid-internal-static", 22));
  97 }
  98
  99 /*
 100  * makes internal url with a given host and port (remote internal url)
 101  */
 102 char *
 103 internalRemoteUri(const char *host, unsigned short port, const char *dir, const char *name)
 104 {
 105     static char lc_host[SQUIDHOSTNAMELEN];
 106     assert(host && name);
 107     /* convert host name to lower case */
 108     xstrncpy(lc_host, host, SQUIDHOSTNAMELEN);
 109     Tolower(lc_host);
 110
 111     /* check for an IP address and format appropriately if found */
 112     Ip::Address test = lc_host;
 113     if ( !test.IsAnyAddr() ) {
 114         test.ToHostname(lc_host,SQUIDHOSTNAMELEN);
 115     }
 116
 117     /*
 118      * append the domain in order to mirror the requests with appended
 119      * domains
 120      */
 121
 122     /* For IPv6 addresses also check for a colon */
 123     if (Config.appendDomain && !strchr(lc_host, '.') && !strchr(lc_host, ':'))
 124         strncat(lc_host, Config.appendDomain, SQUIDHOSTNAMELEN -
 125                 strlen(lc_host) - 1);
 126
 127     /* build uri in mb */
 128     static MemBuf mb;
 129
 130     mb.reset();
 131
 132     mb.Printf("http://%s", lc_host);
 133
 134     /* append port if not default */
 135     if (port && port != urlDefaultPort(AnyP::PROTO_HTTP))
 136         mb.Printf(":%d", port);
 137
 138     if (dir)
 139         mb.Printf("%s", dir);
 140
 141     mb.Printf("%s", name);
 142
 143     /* return a pointer to a local static buffer */
 144     return mb.buf;
 145 }
 146
 147 /*
 148  * makes internal url with local host and port
 149  */
 150 char *
 151 internalLocalUri(const char *dir, const char *name)
 152 {
 153     return internalRemoteUri(getMyHostname(),
 154                              getMyPort(), dir, name);
 155 }
 156
 157 const char *
 158 internalHostname(void)
 159 {
 160     LOCAL_ARRAY(char, host, SQUIDHOSTNAMELEN + 1);
 161     xstrncpy(host, getMyHostname(), SQUIDHOSTNAMELEN);
 162
 163     /* For IPv6 addresses also check for a colon */
 164     if (Config.appendDomain && !strchr(host, '.') && !strchr(host, ':'))
 165         strncat(host, Config.appendDomain, SQUIDHOSTNAMELEN -
 166                 strlen(host) - 1);
 167
 168     Tolower(host);
 169
 170     return host;
 171 }
 172
 173 int
 174 internalHostnameIs(const char *arg)
 175 {
 176     wordlist *w;
 177
 178     if (0 == strcmp(arg, internalHostname()))
 179         return 1;
 180
 181     for (w = Config.hostnameAliases; w; w = w->next)
 182         if (0 == strcmp(arg, w->key))
 183             return 1;
 184
 185     return 0;
 186 }