Uri.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2025 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/forward.h"
13 #include "anyp/UriScheme.h"
14 #include "ip/Address.h"
15 #include "rfc2181.h"
16 #include "sbuf/SBuf.h"
17 
18 #include <iosfwd>
19 
20 class HttpRequestMethod;
21 
22 namespace AnyP
23 {
24 
31 class Uri
32 {
34 
35 public:
36  Uri(): hostIsNumeric_(false) { *host_ = 0; }
37  Uri(AnyP::UriScheme const &aScheme);
38  Uri(const Uri &) = default;
39  Uri(Uri &&) = default;
40  Uri &operator =(const Uri &) = default;
41  Uri &operator =(Uri &&) = default;
42 
43  void clear() {
45  hostIsNumeric_ = false;
46  *host_ = 0;
48  port_ = std::nullopt;
49  touch();
50  }
51  void touch();
52 
53  bool parse(const HttpRequestMethod &, const SBuf &url);
54 
56  static char *cleanup(const char *uri);
57 
58  AnyP::UriScheme const & getScheme() const {return scheme_;}
59 
61  void setScheme(const AnyP::ProtocolType &p, const char *str) {
62  scheme_ = AnyP::UriScheme(p, str);
63  touch();
64  }
65  void setScheme(const AnyP::UriScheme &s) {
66  scheme_ = s;
67  touch();
68  }
69 
70  void userInfo(const SBuf &s) {userInfo_=s; touch();}
73  const SBuf &userInfo() const {return userInfo_;}
74 
75  void host(const char *src);
76  const char *host(void) const {return host_;}
77  int hostIsNumeric(void) const {return hostIsNumeric_;}
78  Ip::Address const & hostIP(void) const {return hostAddr_;}
79 
82  std::optional<Host> parsedHost() const;
83 
87  SBuf hostOrIp() const;
88 
90  void port(const Port p) { port_ = p; touch(); }
92  Port port() const { return port_; }
95 
96  void path(const char *p) {path_=p; touch();}
97  void path(const SBuf &p) {path_=p; touch();}
98  const SBuf &path() const;
99 
106  void addRelativePath(const char *relUrl);
107 
109  static const SBuf &SlashPath();
110 
112  static const SBuf &Asterisk();
113 
116  static SBuf Encode(const SBuf &, const CharacterSet &expected);
117 
119  static SBuf Decode(const SBuf &);
120 
131  SBuf &authority(bool requirePort = false) const;
132 
140  SBuf &absolute() const;
141 
143  SBuf &absolutePath() const;
144 
146  SBuf &originForm() const { return absolutePath(); }
147 
148 private:
150 
152  int parsePort(Parser::Tokenizer &) const;
153 
175 
176  SBuf userInfo_; // aka 'URL-login'
177 
178  // XXX: uses char[] instead of SBUf to reduce performance regressions
179  // from c_str() since most code using this is not yet using SBuf
183 
185 
186  // XXX: for now includes query-string.
188 
189  // pre-assembled URI forms
192  mutable SBuf absolute_;
193  mutable SBuf absolutePath_;
194 };
195 
196 inline std::ostream &
197 operator <<(std::ostream &os, const Uri &url)
198 {
199  // none means explicit empty string for scheme.
200  if (url.getScheme() != PROTO_NONE)
201  os << url.getScheme().image();
202  os << ":";
203 
204  // no authority section on URN
205  if (url.getScheme() != PROTO_URN)
206  os << "//" << url.authority();
207 
208  // path is what it is - including absent
209  os << url.absolutePath();
210  return os;
211 }
212 
213 } // namespace AnyP
214 
215 /* Deprecated functions for Legacy code handling URLs */
216 
217 class HttpRequest;
218 
219 void urlInitialize(void);
224 const char *urlCanonicalFakeHttps(const HttpRequest * request);
225 bool urlIsRelative(const char *);
226 char *urlRInternal(const char *host, unsigned short port, const char *dir, const char *name);
227 char *urlInternal(const char *dir, const char *name);
228 bool urlAppendDomain(char *host);
229 
231  mdnNone = 0,
234 };
235 
269 int matchDomainName(const char *host, const char *domain, MatchDomainNameFlags flags = mdnNone);
270 bool urlCheckRequest(const HttpRequest *);
271 void urlExtMethodConfigure(void);
272 
273 #endif /* SQUID_SRC_ANYP_URI_H */
274 
static char * cleanup(const char *uri)
Definition: Uri.cc:1076
bool hostIsNumeric_
whether the authority 'host' is a raw-IP
Definition: Uri.h:181
@ mdnNone
Definition: Uri.h:231
bool urlAppendDomain(char *host)
apply append_domain config to the given hostname
Definition: Uri.cc:285
void userInfo(const SBuf &s)
Definition: Uri.h:70
AnyP::Uri url
the request URI
Definition: HttpRequest.h:115
Definition: Uri.h:31
char host_[SQUIDHOSTNAMELEN]
string representation of the URI authority name or IP
Definition: Uri.h:180
@ mdnHonorWildcards
Definition: Uri.h:232
RequestFlags flags
Definition: HttpRequest.h:141
@ PROTO_NONE
Definition: ProtocolType.h:24
SBuf hostOrIp() const
Definition: Uri.cc:158
bool parse(const HttpRequestMethod &, const SBuf &url)
Definition: Uri.cc:314
std::ostream & operator<<(std::ostream &, const Host &)
Definition: Host.cc:80
Definition: SBuf.h:93
void defaultPort()
reset the port to the default port number for the current scheme
Definition: Uri.h:94
SBuf authorityWithPort_
RFC 7230 section 5.3.3 authority with explicit port.
Definition: Uri.h:191
const char * urlCanonicalFakeHttps(const HttpRequest *request)
Definition: Uri.cc:819
static int port
Definition: ldap_backend.cc:70
void urlInitialize(void)
Definition: Uri.cc:200
void urlExtMethodConfigure(void)
char * urlCanonicalCleanWithoutRequest(const SBuf &url, const HttpRequestMethod &, const AnyP::UriScheme &)
Definition: Uri.cc:790
void setScheme(const AnyP::UriScheme &s)
Definition: Uri.h:65
Port port() const
authority port subcomponent
Definition: Uri.h:92
@ PROTO_URN
Definition: ProtocolType.h:35
bool urlCheckRequest(const HttpRequest *)
Definition: Uri.cc:1002
ProtocolType
Definition: ProtocolType.h:23
Uri & operator=(const Uri &)=default
AnyP::UriScheme scheme_
Definition: Uri.h:174
void path(const SBuf &p)
Definition: Uri.h:97
void clear()
Definition: Uri.h:43
bool urlIsRelative(const char *)
Definition: Uri.cc:846
int parsePort(Parser::Tokenizer &) const
Definition: Uri.cc:690
Definition: forward.h:14
const SBuf & userInfo() const
Definition: Uri.h:73
MatchDomainNameFlags
Definition: Uri.h:230
std::optional< Host > parsedHost() const
Definition: Uri.cc:169
void parseUrn(Parser::Tokenizer &)
Definition: Uri.cc:589
char * urlInternal(const char *dir, const char *name)
SBuf image() const
Definition: UriScheme.h:57
SBuf path_
URI path segment.
Definition: Uri.h:187
SBuf absolute_
RFC 7230 section 5.3.2 absolute-URI.
Definition: Uri.h:192
const AnyP::UriScheme & getScheme() const
Definition: Uri.h:58
void port(const Port p)
reset authority port subcomponent
Definition: Uri.h:90
SBuf absolutePath_
RFC 3986 section 4.2 absolute-path.
Definition: Uri.h:193
SBuf & authority(bool requirePort=false) const
Definition: Uri.cc:721
char * urlRInternal(const char *host, unsigned short port, const char *dir, const char *name)
int matchDomainName(const char *host, const char *domain, MatchDomainNameFlags flags=mdnNone)
Definition: Uri.cc:903
void setEmpty()
Fast reset of the stored content to what would be after default constructor.
Definition: Address.cc:204
void addRelativePath(const char *relUrl)
Definition: Uri.cc:879
Port port_
authority port subcomponent
Definition: Uri.h:184
MEMPROXY_CLASS(Uri)
SBuf authorityHttp_
RFC 7230 section 5.3.3 authority, maybe without default-port.
Definition: Uri.h:190
static const SBuf & SlashPath()
the static '/' default URL-path
Definition: Uri.cc:135
SBuf & absolute() const
Definition: Uri.cc:743
void path(const char *p)
Definition: Uri.h:96
static SBuf Decode(const SBuf &)
%-decode the given buffer
Definition: Uri.cc:105
@ mdnRejectSubsubDomains
Definition: Uri.h:233
const Ip::Address & hostIP(void) const
Definition: Uri.h:78
SBuf userInfo_
Definition: Uri.h:176
std::optional< KnownPort > Port
validated/supported port number (if any)
Definition: UriScheme.h:26
Uri()
Definition: Uri.h:36
SBuf & absolutePath() const
RFC 3986 section 4.2 relative reference called 'absolute-path'.
Definition: Uri.cc:775
int hostIsNumeric(void) const
Definition: Uri.h:77
optimized set of C chars, with quick membership test and merge support
Definition: CharacterSet.h:17
const SBuf & path() const
Definition: Uri.cc:188
void setScheme(const AnyP::ProtocolType &p, const char *str)
convert the URL scheme to that given
Definition: Uri.h:61
const char * host(void) const
Definition: Uri.h:76
SBuf & originForm() const
The RFC 7230 origin-form URI for currently stored values.
Definition: Uri.h:146
Ip::Address hostAddr_
binary representation of the URI authority if it is a raw-IP
Definition: Uri.h:182
static const SBuf & Asterisk()
the static '*' pseudo-URI
Definition: Uri.cc:128
static SBuf Encode(const SBuf &, const CharacterSet &expected)
Definition: Uri.cc:76
SBuf parseHost(Parser::Tokenizer &) const
Definition: Uri.cc:620
#define SQUIDHOSTNAMELEN
Definition: rfc2181.h:30
void touch()
clear the cached URI display forms
Definition: Uri.cc:712

 

Introduction

Documentation

Support

Miscellaneous