UriScheme.cc
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2020 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 /* DEBUG: section 23 URL Scheme parsing */
10 
11 #include "squid.h"
12 #include "anyp/UriScheme.h"
13 
15 
16 AnyP::UriScheme::UriScheme(AnyP::ProtocolType const aScheme, const char *img) :
17  theScheme_(aScheme)
18 {
19  // RFC 3986 section 3.1: schemes are case-insensitive.
20 
21  // To improve diagnostic, remember exactly how an unsupported scheme looks like.
22  // XXX: Object users may rely on toLower() canonicalization that we refuse to provide.
23  if (img && theScheme_ == AnyP::PROTO_UNKNOWN)
24  image_ = img;
25 
26  // XXX: A broken caller supplies an image of an absent scheme?
27  // XXX: We assume that the caller is using a lower-case image.
28  else if (img && theScheme_ == AnyP::PROTO_NONE)
29  image_ = img;
30 
33  // else, the image remains empty (e.g., "://example.com/")
34  // hopefully, theScheme_ is PROTO_NONE here
35 }
36 
37 void
39 {
40  if (LowercaseSchemeNames_.empty()) {
41  LowercaseSchemeNames_.reserve(sizeof(SBuf) * AnyP::PROTO_MAX);
42  // TODO: use base/EnumIterator.h if possible
43  for (int i = AnyP::PROTO_NONE; i < AnyP::PROTO_MAX; ++i) {
44  SBuf image(ProtocolType_str[i]);
45  image.toLower();
46  LowercaseSchemeNames_.emplace_back(image);
47  }
48  }
49 }
50 
53 {
54  if (scheme.isEmpty())
55  return AnyP::PROTO_NONE;
56 
57  Init();
58 
59  auto img = scheme;
60  img.toLower();
61  // TODO: use base/EnumIterator.h if possible
62  for (int i = AnyP::PROTO_NONE + 1; i < AnyP::PROTO_UNKNOWN; ++i) {
63  if (LowercaseSchemeNames_.at(i) == img)
64  return AnyP::ProtocolType(i);
65  }
66 
67  return AnyP::PROTO_UNKNOWN;
68 }
69 
70 unsigned short
72 {
73  switch (theScheme_) {
74 
75  case AnyP::PROTO_HTTP:
76  return 80;
77 
78  case AnyP::PROTO_HTTPS:
79  return 443;
80 
81  case AnyP::PROTO_FTP:
82  return 21;
83 
84  case AnyP::PROTO_COAP:
85  case AnyP::PROTO_COAPS:
86  // coaps:// default is TBA as of draft-ietf-core-coap-08.
87  // Assuming IANA policy of allocating same port for base and TLS protocol versions will occur.
88  return 5683;
89 
90  case AnyP::PROTO_GOPHER:
91  return 70;
92 
93  case AnyP::PROTO_WAIS:
94  return 210;
95 
97  return CACHE_HTTP_PORT;
98 
99  case AnyP::PROTO_WHOIS:
100  return 43;
101 
102  default:
103  return 0;
104  }
105 }
106 
static const AnyP::ProtocolType FindProtocolType(const SBuf &)
Definition: UriScheme.cc:52
@ PROTO_COAPS
Definition: ProtocolType.h:29
bool isEmpty() const
Definition: SBuf.h:420
@ PROTO_NONE
Definition: ProtocolType.h:24
#define CACHE_HTTP_PORT
Definition: squid.h:16
AnyP::ProtocolType theScheme_
This is a typecode pointer into the enum/registry of protocols handled.
Definition: UriScheme.h:66
const char * ProtocolType_str[]
Definition: SBuf.h:86
void toLower()
converts all characters to lower case;
Definition: SBuf.cc:818
@ PROTO_COAP
Definition: ProtocolType.h:28
@ PROTO_UNKNOWN
Definition: ProtocolType.h:43
ProtocolType
Definition: ProtocolType.h:23
@ PROTO_MAX
Definition: ProtocolType.h:44
static LowercaseSchemeNames LowercaseSchemeNames_
Definition: UriScheme.h:63
static void Init()
initializes down-cased protocol scheme names array
Definition: UriScheme.cc:38
@ PROTO_GOPHER
Definition: ProtocolType.h:30
@ PROTO_CACHE_OBJECT
Definition: ProtocolType.h:32
@ PROTO_WHOIS
Definition: ProtocolType.h:38
@ PROTO_HTTPS
Definition: ProtocolType.h:27
@ PROTO_FTP
Definition: ProtocolType.h:26
@ PROTO_HTTP
Definition: ProtocolType.h:25
unsigned short defaultPort() const
Definition: UriScheme.cc:71
@ PROTO_WAIS
Definition: ProtocolType.h:31
SBuf image_
the string representation
Definition: UriScheme.h:69
void Init(void)
prepares to parse ACLs configuration
Definition: AclRegs.cc:114
std::vector< SBuf > LowercaseSchemeNames
Definition: UriScheme.h:27

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors