src/URL.h

   1 /*
   2  *
   3  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   4  * ----------------------------------------------------------
   5  *
   6  *  Squid is the result of efforts by numerous individuals from
   7  *  the Internet community; see the CONTRIBUTORS file for full
   8  *  details.   Many organizations have provided support for Squid's
   9  *  development; see the SPONSORS file for full details.  Squid is
  10  *  Copyrighted (C) 2001 by the Regents of the University of
  11  *  California; see the COPYRIGHT file for full details.  Squid
  12  *  incorporates software developed and/or copyrighted by other
  13  *  sources; see the CREDITS file for full details.
  14  *
  15  *  This program is free software; you can redistribute it and/or modify
  16  *  it under the terms of the GNU General Public License as published by
  17  *  the Free Software Foundation; either version 2 of the License, or
  18  *  (at your option) any later version.
  19  *
  20  *  This program is distributed in the hope that it will be useful,
  21  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  *  GNU General Public License for more details.
  24  *
  25  *  You should have received a copy of the GNU General Public License
  26  *  along with this program; if not, write to the Free Software
  27  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  28  *
  29  */
  30
  31 #ifndef SQUID_SRC_URL_H
  32 #define SQUID_SRC_URL_H
  33
  34 #include "anyp/ProtocolType.h"
  35 #include "MemPool.h"
  36 #include "URLScheme.h"
  37
  38 /**
  39  \ingroup POD
  40  *
  41  * The URL class represents a Uniform Resource Location
  42  */
  43 class URL
  44 {
  45
  46 public:
  47
  48     MEMPROXY_CLASS(URL);
  49     URL();
  50     URL(URLScheme const &);
  51     URLScheme const & getScheme() const {return scheme; }
  52
  53 private:
  54     /**
  55      \par
  56      * The scheme of this URL. This has the 'type code' smell about it.
  57      * In future we may want to make the methods that dispatch based on
  58      * the scheme virtual and have a class per protocol.
  59      \par
  60      * On the other hand, having Protocol as an explicit concept is useful,
  61      * see for instance the ACLProtocol acl type. One way to represent this
  62      * is to have one prototype URL with no host etc for each scheme,
  63      * another is to have an explicit scheme class, and then each URL class
  64      * could be a subclass of the scheme. Another way is one instance of
  65      * a URLScheme class instance for each URLScheme we support, and one URL
  66      * class for each manner of treating the scheme : a Hierarchical URL, a
  67      * non-hierarchical URL etc.
  68      \par
  69      * Deferring the decision, its a type code for now. RBC 20060507.
  70      \par
  71      * In order to make taking any of these routes easy, scheme is private
  72      * and immutable, only settable at construction time,
  73      */
  74     URLScheme const scheme;
  75 };
  76
  77 MEMPROXY_CLASS_INLINE(URL);
  78
  79 class HttpRequest;
  80 class HttpRequestMethod;
  81
  82 extern AnyP::ProtocolType urlParseProtocol(const char *, const char *e = NULL);
  83 extern void urlInitialize(void);
  84 extern HttpRequest *urlParse(const HttpRequestMethod&, char *, HttpRequest *request = NULL);
  85 extern const char *urlCanonical(HttpRequest *);
  86 extern char *urlCanonicalClean(const HttpRequest *);
  87 extern const char *urlCanonicalFakeHttps(const HttpRequest * request);
  88 extern bool urlIsRelative(const char *);
  89 extern char *urlMakeAbsolute(const HttpRequest *, const char *);
  90 extern char *urlRInternal(const char *host, unsigned short port, const char *dir, const char *name);
  91 extern char *urlInternal(const char *dir, const char *name);
  92 extern int matchDomainName(const char *host, const char *domain);
  93 extern int urlCheckRequest(const HttpRequest *);
  94 extern int urlDefaultPort(AnyP::ProtocolType p);
  95 extern char *urlHostname(const char *url);
  96 extern void urlExtMethodConfigure(void);
  97
  98 #endif /* SQUID_SRC_URL_H_H */