Uri.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2019 The Squid Software Foundation and contributors
3  *
4  * Squid software is distributed under GPLv2+ license and includes
5  * contributions from numerous individuals and organizations.
6  * Please see the COPYING and CONTRIBUTORS files for details.
7  */
8 
9 #ifndef SQUID_SRC_ANYP_URI_H
10 #define SQUID_SRC_ANYP_URI_H
11 
12 #include "anyp/UriScheme.h"
13 #include "ip/Address.h"
14 #include "rfc2181.h"
15 #include "sbuf/SBuf.h"
16 
17 #include <iosfwd>
18 
19 class HttpRequestMethod;
20 
21 namespace AnyP
22 {
23 
30 class Uri
31 {
33 
34 public:
36  Uri(AnyP::UriScheme const &aScheme);
37  Uri(const Uri &other) {
38  this->operator =(other);
39  }
40  Uri &operator =(const Uri &o) {
41  scheme_ = o.scheme_;
42  userInfo_ = o.userInfo_;
43  memcpy(host_, o.host_, sizeof(host_));
45  hostAddr_ = o.hostAddr_;
46  port_ = o.port_;
47  path_ = o.path_;
48  touch();
49  return *this;
50  }
51 
52  void clear() {
54  hostIsNumeric_ = false;
55  *host_ = 0;
57  port_ = 0;
58  touch();
59  }
60  void touch();
61 
62  bool parse(const HttpRequestMethod &, const SBuf &url);
63 
65  static char *cleanup(const char *uri);
66 
67  AnyP::UriScheme const & getScheme() const {return scheme_;}
68 
70  void setScheme(const AnyP::ProtocolType &p, const char *str) {
71  scheme_ = AnyP::UriScheme(p, str);
72  touch();
73  }
74  void setScheme(const AnyP::UriScheme &s) {
75  scheme_ = s;
76  touch();
77  }
78 
79  void userInfo(const SBuf &s) {userInfo_=s; touch();}
80  const SBuf &userInfo() const {return userInfo_;}
81 
82  void host(const char *src);
83  const char *host(void) const {return host_;}
84  int hostIsNumeric(void) const {return hostIsNumeric_;}
85  Ip::Address const & hostIP(void) const {return hostAddr_;}
86 
90  SBuf hostOrIp() const;
91 
92  void port(unsigned short p) {port_=p; touch();}
93  unsigned short port() const {return port_;}
96 
97  void path(const char *p) {path_=p; touch();}
98  void path(const SBuf &p) {path_=p; touch();}
99  const SBuf &path() const;
100 
102  static const SBuf &SlashPath();
103 
105  static const SBuf &Asterisk();
106 
117  SBuf &authority(bool requirePort = false) const;
118 
126  SBuf &absolute() const;
127 
128 private:
130 
152 
153  SBuf userInfo_; // aka 'URL-login'
154 
155  // XXX: uses char[] instead of SBUf to reduce performance regressions
156  // from c_str() since most code using this is not yet using SBuf
160 
161  unsigned short port_;
162 
163  // XXX: for now includes query-string.
165 
166  // pre-assembled URI forms
169  mutable SBuf absolute_;
170 };
171 
172 } // namespace AnyP
173 
174 inline std::ostream &
175 operator <<(std::ostream &os, const AnyP::Uri &url)
176 {
177  // none means explicit empty string for scheme.
178  if (url.getScheme() != AnyP::PROTO_NONE)
179  os << url.getScheme().image();
180  os << ":";
181 
182  // no authority section on URN
183  if (url.getScheme() != AnyP::PROTO_URN)
184  os << "//" << url.authority();
185 
186  // path is what it is - including absent
187  os << url.path();
188  return os;
189 }
190 
191 /* Deprecated functions for Legacy code handling URLs */
192 
193 class HttpRequest;
194 
195 void urlInitialize(void);
199 char *urlCanonicalCleanWithoutRequest(const SBuf &url, const HttpRequestMethod &, const AnyP::UriScheme &);
200 const char *urlCanonicalFakeHttps(const HttpRequest * request);
201 bool urlIsRelative(const char *);
202 char *urlMakeAbsolute(const HttpRequest *, const char *);
203 char *urlRInternal(const char *host, unsigned short port, const char *dir, const char *name);
204 char *urlInternal(const char *dir, const char *name);
205 bool urlAppendDomain(char *host);
206 
208  mdnNone = 0,
211 };
212 
246 int matchDomainName(const char *host, const char *domain, uint8_t flags = mdnNone);
247 int urlCheckRequest(const HttpRequest *);
248 char *urlHostname(const char *url);
249 void urlExtMethodConfigure(void);
250 
251 #endif /* SQUID_SRC_ANYP_URI_H */
252 
void path(const SBuf &p)
Definition: Uri.h:98
SBuf & authority(bool requirePort=false) const
Definition: Uri.cc:528
SBuf image() const
Definition: UriScheme.h:50
void path(const char *p)
Definition: Uri.h:97
Definition: SBuf.h:86
SBuf userInfo_
Definition: Uri.h:153
unsigned short port() const
Definition: Uri.h:93
char * urlMakeAbsolute(const HttpRequest *, const char *)
Definition: Uri.cc:662
MatchDomainNameFlags
Definition: Uri.h:207
SBuf path_
URI path segment.
Definition: Uri.h:164
static const SBuf & SlashPath()
the static &#39;/&#39; default URL-path
Definition: Uri.cc:41
SBuf authorityHttp_
RFC 7230 section 5.3.3 authority, maybe without default-port.
Definition: Uri.h:167
char * p
Definition: membanger.c:43
char * urlHostname(const char *url)
Definition: Uri.cc:919
MEMPROXY_CLASS(Uri)
static const SBuf & Asterisk()
the static &#39;*&#39; pseudo-URI
Definition: Uri.cc:34
SBuf & absolute() const
Definition: Uri.cc:546
const char * host(void) const
Definition: Uri.h:83
void urlInitialize(void)
Definition: Uri.cc:86
void port(unsigned short p)
Definition: Uri.h:92
int matchDomainName(const char *host, const char *domain, uint8_t flags=mdnNone)
Definition: Uri.cc:721
Uri()
Definition: Uri.h:35
Uri & operator=(const Uri &o)
Definition: Uri.h:40
void setScheme(const AnyP::ProtocolType &p, const char *str)
convert the URL scheme to that given
Definition: Uri.h:70
void touch()
clear the cached URI display forms
Definition: Uri.cc:520
Definition: forward.h:14
char * urlInternal(const char *dir, const char *name)
int hostIsNumeric(void) const
Definition: Uri.h:84
void userInfo(const SBuf &s)
Definition: Uri.h:79
const SBuf & path() const
Definition: Uri.cc:74
bool urlIsRelative(const char *)
Definition: Uri.cc:629
const char * urlCanonicalFakeHttps(const HttpRequest *request)
Definition: Uri.cc:608
bool parse(const HttpRequestMethod &, const SBuf &url)
Definition: Uri.cc:203
unsigned short port_
URL port.
Definition: Uri.h:161
Ip::Address hostAddr_
binary representation of the URI authority if it is a raw-IP
Definition: Uri.h:159
void setEmpty()
Fast reset of the stored content to what would be after default constructor.
Definition: Address.cc:184
bool urlAppendDomain(char *host)
apply append_domain config to the given hostname
Definition: Uri.cc:174
Uri(const Uri &other)
Definition: Uri.h:37
static char * cleanup(const char *uri)
Definition: Uri.cc:1002
bool hostIsNumeric_
whether the authority &#39;host&#39; is a raw-IP
Definition: Uri.h:158
Definition: Uri.h:208
RequestFlags flags
Definition: HttpRequest.h:141
SBuf authorityWithPort_
RFC 7230 section 5.3.3 authority with explicit port.
Definition: Uri.h:168
Definition: Uri.h:30
char * urlRInternal(const char *host, unsigned short port, const char *dir, const char *name)
#define SQUIDHOSTNAMELEN
Definition: rfc2181.h:30
char host_[SQUIDHOSTNAMELEN]
string representation of the URI authority name or IP
Definition: Uri.h:157
ProtocolType
Definition: ProtocolType.h:23
void setScheme(const AnyP::UriScheme &s)
Definition: Uri.h:74
void urlExtMethodConfigure(void)
SBuf hostOrIp() const
Definition: Uri.cc:64
const SBuf & userInfo() const
Definition: Uri.h:80
std::ostream & operator<<(std::ostream &os, ProtocolType const &p)
Definition: ProtocolType.h:54
AnyP::UriScheme scheme_
Definition: Uri.h:151
void defaultPort()
reset the port to the default port number for the current scheme
Definition: Uri.h:95
Ip::Address const & hostIP(void) const
Definition: Uri.h:85
AnyP::UriScheme const & getScheme() const
Definition: Uri.h:67
void clear()
Definition: Uri.h:52
int urlCheckRequest(const HttpRequest *)
Definition: Uri.cc:818
void parseUrn(Parser::Tokenizer &)
Definition: Uri.cc:492
char * urlCanonicalCleanWithoutRequest(const SBuf &url, const HttpRequestMethod &, const AnyP::UriScheme &)
Definition: Uri.cc:579
SBuf absolute_
RFC 7230 section 5.3.2 absolute-URI.
Definition: Uri.h:169
#define false
Definition: GnuRegex.c:233

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors