#include <Uri.h>

Collaboration diagram for AnyP::Uri:

Public Member Functions

 Uri ()
 
 Uri (AnyP::UriScheme const &aScheme)
 
 Uri (const Uri &other)
 
Urioperator= (const Uri &o)
 
void clear ()
 
void touch ()
 clear the cached URI display forms More...
 
bool parse (const HttpRequestMethod &, const SBuf &url)
 
AnyP::UriScheme const & getScheme () const
 
void setScheme (const AnyP::ProtocolType &p, const char *str)
 convert the URL scheme to that given More...
 
void setScheme (const AnyP::UriScheme &s)
 
void userInfo (const SBuf &s)
 
const SBufuserInfo () const
 
void host (const char *src)
 
const char * host (void) const
 
int hostIsNumeric (void) const
 
Ip::Address const & hostIP (void) const
 
SBuf hostOrIp () const
 
void port (unsigned short p)
 
unsigned short port () const
 
void defaultPort ()
 reset the port to the default port number for the current scheme More...
 
void path (const char *p)
 
void path (const SBuf &p)
 
const SBufpath () const
 
SBufauthority (bool requirePort=false) const
 
SBufabsolute () const
 

Static Public Member Functions

static char * cleanup (const char *uri)
 
static const SBufSlashPath ()
 the static '/' default URL-path More...
 
static const SBufAsterisk ()
 the static '*' pseudo-URI More...
 

Private Member Functions

 MEMPROXY_CLASS (Uri)
 
void parseUrn (Parser::Tokenizer &)
 

Private Attributes

AnyP::UriScheme scheme_
 
SBuf userInfo_
 
char host_ [SQUIDHOSTNAMELEN]
 string representation of the URI authority name or IP More...
 
bool hostIsNumeric_
 whether the authority 'host' is a raw-IP More...
 
Ip::Address hostAddr_
 binary representation of the URI authority if it is a raw-IP More...
 
unsigned short port_
 URL port. More...
 
SBuf path_
 URI path segment. More...
 
SBuf authorityHttp_
 RFC 7230 section 5.3.3 authority, maybe without default-port. More...
 
SBuf authorityWithPort_
 RFC 7230 section 5.3.3 authority with explicit port. More...
 
SBuf absolute_
 RFC 7230 section 5.3.2 absolute-URI. More...
 

Detailed Description

Represents a Uniform Resource Identifier. Can store both URL or URN representations.

Governed by RFC 3986

Definition at line 30 of file Uri.h.

Constructor & Destructor Documentation

◆ Uri() [1/3]

AnyP::Uri::Uri ( )
inline

Definition at line 35 of file Uri.h.

References host_.

◆ Uri() [2/3]

AnyP::Uri::Uri ( AnyP::UriScheme const &  aScheme)

Definition at line 992 of file Uri.cc.

References host_.

◆ Uri() [3/3]

AnyP::Uri::Uri ( const Uri other)
inline

Definition at line 37 of file Uri.h.

References operator=().

Member Function Documentation

◆ absolute()

SBuf & AnyP::Uri::absolute ( ) const

The absolute-form URI for currently stored values.

As defined by RFC 7230 section 5.3.3 this form omits the userinfo@ field from RFC 3986 defined authority segments when the protocol scheme is http: or https:.

Definition at line 546 of file Uri.cc.

References absolute_, SBuf::append(), authority(), getScheme(), host(), SBuf::isEmpty(), MAX_URL, path(), AnyP::PROTO_FTP, AnyP::PROTO_UNKNOWN, AnyP::PROTO_URN, SBuf::reserveCapacity(), and userInfo().

Referenced by asnCacheStart(), HttpRequest::effectiveRequestUri(), path(), UrnState::setUriResFromRequest(), and urlMakeAbsolute().

◆ Asterisk()

const SBuf & AnyP::Uri::Asterisk ( )
static

Definition at line 34 of file Uri.cc.

Referenced by parse(), path(), and urlCheckRequest().

◆ authority()

SBuf & AnyP::Uri::authority ( bool  requirePort = false) const

The authority-form URI for currently stored values.

As defined by RFC 7230 section 5.3.3 this form omits the userinfo@ field from RFC 3986 defined authority segment.

Parameters
requirePortwhen true the port will be included, otherwise port will be elided when it is the default for the current scheme.

Definition at line 528 of file Uri.cc.

References SBuf::append(), SBuf::appendf(), authorityHttp_, authorityWithPort_, defaultPort(), getScheme(), host(), SBuf::isEmpty(), and port().

Referenced by absolute(), Http::One::Server::buildHttpRequest(), Ftp::Gateway::buildTitleUrl(), clientProcessRequest(), copyOneHeaderFromClientsideRequestToUpstreamRequest(), HttpRequest::effectiveRequestUri(), HttpStateData::httpBuildRequestHeader(), internalRemoteUri(), operator<<(), path(), peerAllowedToUse(), Ssl::ServerBump::ServerBump(), Http::Tunneler::Tunneler(), and urlMakeAbsolute().

◆ cleanup()

◆ clear()

void AnyP::Uri::clear ( )
inline

◆ defaultPort()

void AnyP::Uri::defaultPort ( )
inline

Definition at line 95 of file Uri.h.

References defaultPort(), getScheme(), and port().

Referenced by asnCacheStart(), authority(), defaultPort(), and parse().

◆ getScheme()

◆ host() [1/2]

void AnyP::Uri::host ( const char *  src)

Definition at line 48 of file Uri.cc.

References debugs, host_, hostAddr_, hostIsNumeric_, Ip::Address::isAnyAddr(), Ip::Address::setEmpty(), Ip::Address::toHostStr(), touch(), and xstrncpy().

Referenced by asnCacheStart(), Format::Format::assemble(), ConnStateData::borrowPinnedConnection(), ConnStateData::buildFakeRequest(), carpSelectParent(), HttpStateData::checkDateSkew(), DestinationIPLookup::checkForAsync(), clientProcessRequest(), ErrorState::compileLegacyCode(), TunnelStateData::connectDone(), FwdState::connectStart(), ICP2State::created(), FwdState::dispatch(), doV2Query(), Ftp::Gateway::ftpRealm(), ftpSendUser(), TunnelStateData::getHost(), clientReplyContext::identifyFoundObject(), Ssl::PeekingPeerConnector::initialize(), Security::BlindPeerConnector::initialize(), internalRemoteUri(), ACLDestinationASNStrategy::match(), ACLDestinationDomainStrategy::match(), ACLServerNameStrategy::match(), ACLDestinationIP::match(), neighborType(), netdbClosestParent(), netdbUpdatePeer(), FwdState::noteConnection(), TunnelStateData::noteConnection(), Ssl::PeekingPeerConnector::noteNegotiationDone(), operator<<(), ConnStateData::pinConnection(), ConnStateData::postHttpsAccept(), HttpStateData::processReplyBody(), clientReplyContext::purgeRequest(), ConnStateData::serveDelayedError(), UrnState::setUriResFromRequest(), PeerPoolMgr::start(), Ftp::Gateway::start(), TunnelStateData::startConnecting(), testHttpRequest::testCreateFromUrl(), testHttpRequest::testIPv6HostColonBug(), urlCanonicalFakeHttps(), FwdState::usePinned(), and TunnelStateData::usePinned().

◆ host() [2/2]

const char* AnyP::Uri::host ( void  ) const
inline

Definition at line 83 of file Uri.h.

References host_.

Referenced by absolute(), authority(), hostOrIp(), operator<<(), parse(), parseUrn(), and userInfo().

◆ hostIP()

Ip::Address const& AnyP::Uri::hostIP ( void  ) const
inline

Definition at line 85 of file Uri.h.

References hostAddr_, and hostOrIp().

Referenced by hostOrIp(), and ACLDestinationIP::match().

◆ hostIsNumeric()

int AnyP::Uri::hostIsNumeric ( void  ) const
inline

Definition at line 84 of file Uri.h.

References hostIsNumeric_.

Referenced by hostOrIp(), ACLDestinationDomainStrategy::match(), and ACLDestinationIP::match().

◆ hostOrIp()

SBuf AnyP::Uri::hostOrIp ( ) const
Returns
the host subcomponent of the authority component If the host is an IPv6 address, returns that IP address without [brackets]! See RFC 3986 Section 3.2.2.

Definition at line 64 of file Uri.cc.

References host(), hostIP(), hostIsNumeric(), and MAX_IPSTRLEN.

Referenced by hostIP(), and ConnStateData::initiateTunneledRequest().

◆ MEMPROXY_CLASS()

AnyP::Uri::MEMPROXY_CLASS ( Uri  )
private

◆ operator=()

Uri& AnyP::Uri::operator= ( const Uri o)
inline

Definition at line 40 of file Uri.h.

References host_, hostAddr_, hostIsNumeric_, path_, port_, scheme_, touch(), and userInfo_.

Referenced by Uri().

◆ parse()

◆ parseUrn()

void AnyP::Uri::parseUrn ( Parser::Tokenizer tok)
private

Governed by RFC 8141 section 2:

assigned-name = "urn" ":" NID ":" NSS NID = (alphanum) 0*30(ldh) (alphanum) ldh = alphanum / "-" NSS = pchar *(pchar / "/")

RFC 3986 Appendix D.2 defines (as deprecated):

alphanum = ALPHA / DIGIT

Notice that NID is exactly 2-32 characters in length.

Definition at line 492 of file Uri.cc.

References CharacterSet::ALPHA, SBuf::begin(), SBuf::c_str(), debugs, CharacterSet::DIGIT, Here, host(), SBuf::length(), path(), Parser::Tokenizer::prefix(), AnyP::PROTO_URN, SBuf::rbegin(), Parser::Tokenizer::remaining(), setScheme(), and Parser::Tokenizer::skip().

Referenced by parse(), and path().

◆ path() [1/3]

◆ path() [2/3]

void AnyP::Uri::path ( const SBuf p)
inline

Definition at line 98 of file Uri.h.

References absolute(), Asterisk(), authority(), p, parseUrn(), path(), path_, SlashPath(), and touch().

◆ path() [3/3]

const SBuf & AnyP::Uri::path ( ) const

Definition at line 74 of file Uri.cc.

References SBuf::isEmpty(), path_, AnyP::PROTO_HTTP, AnyP::PROTO_HTTPS, scheme_, and SlashPath().

Referenced by absolute(), parse(), parseUrn(), path(), and urlMakeAbsolute().

◆ port() [1/2]

◆ port() [2/2]

unsigned short AnyP::Uri::port ( ) const
inline

Definition at line 93 of file Uri.h.

References port_.

Referenced by authority(), defaultPort(), operator<<(), and parse().

◆ setScheme() [1/2]

void AnyP::Uri::setScheme ( const AnyP::ProtocolType p,
const char *  str 
)
inline

Definition at line 70 of file Uri.h.

References scheme_, and touch().

Referenced by ConnStateData::buildFakeRequest(), clientProcessRequest(), HttpRequest::initHTTP(), parse(), and parseUrn().

◆ setScheme() [2/2]

void AnyP::Uri::setScheme ( const AnyP::UriScheme s)
inline

Definition at line 74 of file Uri.h.

References scheme_, and touch().

◆ SlashPath()

const SBuf & AnyP::Uri::SlashPath ( )
static

Definition at line 41 of file Uri.cc.

Referenced by path().

◆ touch()

void AnyP::Uri::touch ( )

Definition at line 520 of file Uri.cc.

References absolute_, authorityHttp_, authorityWithPort_, and SBuf::clear().

Referenced by clear(), host(), operator=(), path(), port(), setScheme(), and userInfo().

◆ userInfo() [1/2]

◆ userInfo() [2/2]

const SBuf& AnyP::Uri::userInfo ( ) const
inline

Definition at line 80 of file Uri.h.

References host(), and userInfo_.

Referenced by absolute(), and parse().

Member Data Documentation

◆ absolute_

SBuf AnyP::Uri::absolute_
mutableprivate

Definition at line 169 of file Uri.h.

Referenced by absolute(), and touch().

◆ authorityHttp_

SBuf AnyP::Uri::authorityHttp_
mutableprivate

Definition at line 167 of file Uri.h.

Referenced by authority(), and touch().

◆ authorityWithPort_

SBuf AnyP::Uri::authorityWithPort_
mutableprivate

Definition at line 168 of file Uri.h.

Referenced by authority(), and touch().

◆ host_

char AnyP::Uri::host_[SQUIDHOSTNAMELEN]
private

Definition at line 157 of file Uri.h.

Referenced by clear(), host(), operator=(), and Uri().

◆ hostAddr_

Ip::Address AnyP::Uri::hostAddr_
private

Definition at line 159 of file Uri.h.

Referenced by clear(), host(), hostIP(), and operator=().

◆ hostIsNumeric_

bool AnyP::Uri::hostIsNumeric_
private

Definition at line 158 of file Uri.h.

Referenced by clear(), host(), hostIsNumeric(), and operator=().

◆ path_

SBuf AnyP::Uri::path_
private

Definition at line 164 of file Uri.h.

Referenced by operator=(), and path().

◆ port_

unsigned short AnyP::Uri::port_
private

Definition at line 161 of file Uri.h.

Referenced by clear(), operator=(), and port().

◆ scheme_

AnyP::UriScheme AnyP::Uri::scheme_
private
The scheme of this URL. This has the 'type code' smell about it. In future we may want to make the methods that dispatch based on the scheme virtual and have a class per protocol.
On the other hand, having Protocol as an explicit concept is useful, see for instance the ACLProtocol acl type. One way to represent this is to have one prototype URL with no host etc for each scheme, another is to have an explicit scheme class, and then each URL class could be a subclass of the scheme. Another way is one instance of a AnyP::UriScheme class instance for each URL scheme we support, and one class for each manner of treating the scheme : a Hierarchical URL, a non-hierarchical URL etc.
Deferring the decision, its a type code for now. RBC 20060507.
In order to make taking any of these routes easy, scheme is private, only settable at construction time, or with explicit setter

Definition at line 151 of file Uri.h.

Referenced by clear(), getScheme(), operator=(), path(), and setScheme().

◆ userInfo_

SBuf AnyP::Uri::userInfo_
private

Definition at line 153 of file Uri.h.

Referenced by operator=(), and userInfo().


The documentation for this class was generated from the following files:

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors