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/UriScheme.h"
  35 #include "MemPool.h"
  36
  37 /**
  38  \ingroup POD
  39  *
  40  * The URL class represents a Uniform Resource Location
  41  */
  42 class URL
  43 {
  44 public:
  45     MEMPROXY_CLASS(URL);
  46     URL() : scheme_() {}
  47     URL(AnyP::UriScheme const &aScheme) : scheme_(aScheme) {}
  48
  49     void clear() {
  50         scheme_=AnyP::PROTO_NONE;
  51     }
  52
  53     AnyP::UriScheme const & getScheme() const {return scheme_;}
  54
  55     /// convert the URL scheme to that given
  56     void setScheme(const AnyP::ProtocolType &p) {scheme_=p;}
  57
  58 private:
  59     /**
  60      \par
  61      * The scheme of this URL. This has the 'type code' smell about it.
  62      * In future we may want to make the methods that dispatch based on
  63      * the scheme virtual and have a class per protocol.
  64      \par
  65      * On the other hand, having Protocol as an explicit concept is useful,
  66      * see for instance the ACLProtocol acl type. One way to represent this
  67      * is to have one prototype URL with no host etc for each scheme,
  68      * another is to have an explicit scheme class, and then each URL class
  69      * could be a subclass of the scheme. Another way is one instance of
  70      * a AnyP::UriScheme class instance for each URL scheme we support, and one URL
  71      * class for each manner of treating the scheme : a Hierarchical URL, a
  72      * non-hierarchical URL etc.
  73      \par
  74      * Deferring the decision, its a type code for now. RBC 20060507.
  75      \par
  76      * In order to make taking any of these routes easy, scheme is private
  77      * and immutable, only settable at construction time,
  78      */
  79     AnyP::UriScheme scheme_;
  80 };
  81
  82 MEMPROXY_CLASS_INLINE(URL);
  83
  84 class HttpRequest;
  85 class HttpRequestMethod;
  86
  87 AnyP::ProtocolType urlParseProtocol(const char *, const char *e = NULL);
  88 void urlInitialize(void);
  89 HttpRequest *urlParse(const HttpRequestMethod&, char *, HttpRequest *request = NULL);
  90 const char *urlCanonical(HttpRequest *);
  91 char *urlCanonicalClean(const HttpRequest *);
  92 const char *urlCanonicalFakeHttps(const HttpRequest * request);
  93 bool urlIsRelative(const char *);
  94 char *urlMakeAbsolute(const HttpRequest *, const char *);
  95 char *urlRInternal(const char *host, unsigned short port, const char *dir, const char *name);
  96 char *urlInternal(const char *dir, const char *name);
  97 int matchDomainName(const char *host, const char *domain);
  98 int urlCheckRequest(const HttpRequest *);
  99 int urlDefaultPort(AnyP::ProtocolType p);
 100 char *urlHostname(const char *url);
 101 void urlExtMethodConfigure(void);
 102
 103 #endif /* SQUID_SRC_URL_H_H */