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 char *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 
75  void userInfo(const SBuf &s) {userInfo_=s; touch();}
76  const SBuf &userInfo() const {return userInfo_;}
77 
78  void host(const char *src);
79  const char *host(void) const {return host_;}
80  int hostIsNumeric(void) const {return hostIsNumeric_;}
81  Ip::Address const & hostIP(void) const {return hostAddr_;}
82 
83  void port(unsigned short p) {port_=p; touch();}
84  unsigned short port() const {return port_;}
85 
86  void path(const char *p) {path_=p; touch();}
87  void path(const SBuf &p) {path_=p; touch();}
88  const SBuf &path() const;
89 
91  static const SBuf &SlashPath();
92 
94  static const SBuf &Asterisk();
95 
106  SBuf &authority(bool requirePort = false) const;
107 
115  SBuf &absolute() const;
116 
117 private:
118  void parseFinish(const AnyP::ProtocolType, const char *const, const char *const, const char *const, const SBuf &, const int);
119 
141 
142  SBuf userInfo_; // aka 'URL-login'
143 
144  // XXX: uses char[] instead of SBUf to reduce performance regressions
145  // from c_str() since most code using this is not yet using SBuf
149 
150  unsigned short port_;
151 
152  // XXX: for now includes query-string.
154 
155  // pre-assembled URI forms
158  mutable SBuf absolute_;
159 };
160 
161 } // namespace AnyP
162 
163 inline std::ostream &
164 operator <<(std::ostream &os, const AnyP::Uri &url)
165 {
166  // none means explicit empty string for scheme.
167  if (url.getScheme() != AnyP::PROTO_NONE)
168  os << url.getScheme().image();
169  os << ":";
170 
171  // no authority section on URN
172  if (url.getScheme() != AnyP::PROTO_URN)
173  os << "//" << url.authority();
174 
175  // path is what it is - including absent
176  os << url.path();
177  return os;
178 }
179 
180 /* Deprecated functions for Legacy code handling URLs */
181 
182 class HttpRequest;
183 
184 void urlInitialize(void);
188 char *urlCanonicalCleanWithoutRequest(const SBuf &url, const HttpRequestMethod &, const AnyP::UriScheme &);
189 const char *urlCanonicalFakeHttps(const HttpRequest * request);
190 bool urlIsRelative(const char *);
191 char *urlMakeAbsolute(const HttpRequest *, const char *);
192 char *urlRInternal(const char *host, unsigned short port, const char *dir, const char *name);
193 char *urlInternal(const char *dir, const char *name);
194 
196  mdnNone = 0,
199 };
200 
234 int matchDomainName(const char *host, const char *domain, uint8_t flags = mdnNone);
235 int urlCheckRequest(const HttpRequest *);
236 char *urlHostname(const char *url);
237 void urlExtMethodConfigure(void);
238 
239 #endif /* SQUID_SRC_ANYP_URI_H */
240 
void path(const SBuf &p)
Definition: Uri.h:87
SBuf & authority(bool requirePort=false) const
Definition: Uri.cc:470
SBuf image() const
Definition: UriScheme.h:50
void path(const char *p)
Definition: Uri.h:86
Definition: SBuf.h:86
SBuf userInfo_
Definition: Uri.h:142
unsigned short port() const
Definition: Uri.h:84
char * urlMakeAbsolute(const HttpRequest *, const char *)
Definition: Uri.cc:601
MatchDomainNameFlags
Definition: Uri.h:195
SBuf path_
URI path segment.
Definition: Uri.h:153
static const SBuf & SlashPath()
the static &#39;/&#39; default URL-path
Definition: Uri.cc:40
SBuf authorityHttp_
RFC 7230 section 5.3.3 authority, maybe without default-port.
Definition: Uri.h:156
char * p
Definition: membanger.c:43
char * urlHostname(const char *url)
Definition: Uri.cc:858
MEMPROXY_CLASS(Uri)
static const SBuf & Asterisk()
the static &#39;*&#39; pseudo-URI
Definition: Uri.cc:33
SBuf & absolute() const
Definition: Uri.cc:488
const char * host(void) const
Definition: Uri.h:79
void urlInitialize(void)
Definition: Uri.cc:75
void port(unsigned short p)
Definition: Uri.h:83
int matchDomainName(const char *host, const char *domain, uint8_t flags=mdnNone)
Definition: Uri.cc:660
Uri()
Definition: Uri.h:35
Uri & operator=(const Uri &o)
Definition: Uri.h:40
bool parse(const HttpRequestMethod &, const char *url)
Definition: Uri.cc:191
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:462
Definition: forward.h:14
char * urlInternal(const char *dir, const char *name)
int hostIsNumeric(void) const
Definition: Uri.h:80
void userInfo(const SBuf &s)
Definition: Uri.h:75
const SBuf & path() const
Definition: Uri.cc:63
bool urlIsRelative(const char *)
Definition: Uri.cc:568
const char * urlCanonicalFakeHttps(const HttpRequest *request)
Definition: Uri.cc:547
unsigned short port_
URL port.
Definition: Uri.h:150
Ip::Address hostAddr_
binary representation of the URI authority if it is a raw-IP
Definition: Uri.h:148
void setEmpty()
Fast reset of the stored content to what would be after default constructor.
Definition: Address.cc:184
Uri(const Uri &other)
Definition: Uri.h:37
void parseFinish(const AnyP::ProtocolType, const char *const, const char *const, const char *const, const SBuf &, const int)
Update the URL object with parsed URI data.
Definition: Uri.cc:447
static char * cleanup(const char *uri)
Definition: Uri.cc:941
bool hostIsNumeric_
whether the authority &#39;host&#39; is a raw-IP
Definition: Uri.h:147
Definition: Uri.h:196
RequestFlags flags
Definition: HttpRequest.h:133
SBuf authorityWithPort_
RFC 7230 section 5.3.3 authority with explicit port.
Definition: Uri.h:157
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:146
ProtocolType
Definition: ProtocolType.h:22
void urlExtMethodConfigure(void)
const SBuf & userInfo() const
Definition: Uri.h:76
std::ostream & operator<<(std::ostream &os, ProtocolType const &p)
Definition: ProtocolType.h:53
AnyP::UriScheme scheme_
Definition: Uri.h:140
Ip::Address const & hostIP(void) const
Definition: Uri.h:81
AnyP::UriScheme const & getScheme() const
Definition: Uri.h:67
void clear()
Definition: Uri.h:52
int urlCheckRequest(const HttpRequest *)
Definition: Uri.cc:757
char * urlCanonicalCleanWithoutRequest(const SBuf &url, const HttpRequestMethod &, const AnyP::UriScheme &)
Definition: Uri.cc:518
SBuf absolute_
RFC 7230 section 5.3.2 absolute-URI.
Definition: Uri.h:158
#define false
Definition: GnuRegex.c:233

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors