StatusLine.cc
Go to the documentation of this file.
1/*
2 * Copyright (C) 1996-2022 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 57 HTTP Status-line */
10
11#include "squid.h"
12#include "base/Packable.h"
13#include "debug/Stream.h"
15#include "http/StatusLine.h"
16#include "parser/forward.h"
17#include "parser/Tokenizer.h"
18
19#include <algorithm>
20
21void
23{
25}
26
27void
29{
31}
32
33/* set values */
34void
35Http::StatusLine::set(const AnyP::ProtocolVersion &newVersion, const Http::StatusCode newStatus, const char *newReason)
36{
37 version = newVersion;
38 status_ = newStatus;
39 /* Note: no xstrdup for 'reason', assumes constant 'reasons' */
40 reason_ = newReason;
41}
42
43const char *
45{
46 return reason_ ? reason_ : Http::StatusCodeString(status());
47}
48
49void
51{
52 assert(p);
53
54 auto packedStatus = status();
55 auto packedReason = reason();
56
57 if (packedStatus == Http::scNone) {
58 static unsigned int reports = 0;
59 if (++reports <= 100)
60 debugs(57, DBG_IMPORTANT, "ERROR: Squid BUG: the internalized response lacks status-code");
61 packedStatus = Http::scInternalServerError;
62 packedReason = Http::StatusCodeString(packedStatus); // ignore custom reason_ (if any)
63 }
64
65 /* local constants */
66 /* AYJ: see bug 2469 - RFC2616 confirms stating 'SP characters' plural! */
67 static const char *Http1StatusLineFormat = "HTTP/%d.%d %3d %s\r\n";
68 static const char *IcyStatusLineFormat = "ICY %3d %s\r\n";
69
70 /* handle ICY protocol status line specially. Pass on the bad format. */
71 if (version.protocol == AnyP::PROTO_ICY) {
72 debugs(57, 9, "packing sline " << this << " using " << p << ":");
73 debugs(57, 9, "FORMAT=" << IcyStatusLineFormat );
74 debugs(57, 9, "ICY " << packedStatus << " " << packedReason);
75 p->appendf(IcyStatusLineFormat, packedStatus, packedReason);
76 return;
77 }
78
79 debugs(57, 9, "packing sline " << this << " using " << p << ":");
80 debugs(57, 9, "FORMAT=" << Http1StatusLineFormat );
81 debugs(57, 9, "HTTP/" << version.major << "." << version.minor << " " << packedStatus << " " << packedReason);
82 p->appendf(Http1StatusLineFormat, version.major, version.minor, packedStatus, packedReason);
83}
84
85bool
86Http::StatusLine::parse(const String &protoPrefix, const char *start, const char *end)
87{
88 status_ = Http::scInvalidHeader; /* Squid header parsing error */
89
90 // XXX: Http::Message::parse() has a similar check but is using
91 // casesensitive comparison (which is required by HTTP errata?)
92
93 if (protoPrefix.cmp("ICY", 3) == 0) {
94 debugs(57, 3, "Invalid HTTP identifier. Detected ICY protocol instead.");
96 start += protoPrefix.size();
97 } else if (protoPrefix.caseCmp(start, protoPrefix.size()) == 0) {
98
99 start += protoPrefix.size();
100
101 if (!xisdigit(*start))
102 return false;
103
104 // XXX: HTTPbis have defined this to be single-digit version numbers. no need to sscanf()
105 // XXX: furthermore, only HTTP/1 will be using ASCII format digits
106
107 if (sscanf(start, "%d.%d", &version.major, &version.minor) != 2) {
108 debugs(57, 7, "Invalid HTTP identifier.");
109 return false;
110 }
111 } else
112 return false;
113
114 if (!(start = strchr(start, ' ')))
115 return false;
116
117 ++start; // skip SP between HTTP-version and status-code
118
119 assert(start <= end);
120 const auto stdStatusAreaLength = 4; // status-code length plus SP
121 const auto unparsedLength = end - start;
122 const auto statusAreaLength = std::min<size_t>(stdStatusAreaLength, unparsedLength);
123
124 static SBuf statusBuf;
125 statusBuf.assign(start, statusAreaLength);
126 Parser::Tokenizer tok(statusBuf);
127 try {
129 } catch (const Parser::InsufficientInput &) {
130 debugs(57, 7, "need more; have " << unparsedLength);
131 return false;
132 } catch (...) {
133 debugs(57, 3, "cannot parse status-code area: " << CurrentException);
134 return false;
135 }
136
137 // XXX check if the given 'reason' is the default status string, if not save to reason_
138
139 /* we ignore 'reason-phrase' */
140 /* Should assert start < end ? */
141 return true; /* success */
142}
143
std::ostream & CurrentException(std::ostream &os)
prints active (i.e., thrown but not yet handled) exception
#define assert(EX)
Definition: assert.h:19
static int version
static void ParseResponseStatus(Tokenizer &, StatusCode &code)
bool parse(const String &protoPrefix, const char *start, const char *end)
Definition: StatusLine.cc:86
void init()
reset this status-line back to empty state
Definition: StatusLine.cc:22
void clean()
reset this status-line back to Internal Server Error state
Definition: StatusLine.cc:28
void packInto(Packable *) const
pack fields into a Packable object
Definition: StatusLine.cc:50
void set(const AnyP::ProtocolVersion &newVersion, Http::StatusCode newStatus, const char *newReason=nullptr)
Definition: StatusLine.cc:35
const char * reason() const
retrieve the reason string for this status line
Definition: StatusLine.cc:44
void appendf(const char *fmt,...) PRINTF_FORMAT_ARG2
Append operation with printf-style arguments.
Definition: Packable.h:61
thrown by modern "incremental" parsers when they need more data
Definition: forward.h:18
Definition: SBuf.h:94
SBuf & assign(const SBuf &S)
Definition: SBuf.cc:83
int cmp(char const *) const
Definition: String.cc:255
int caseCmp(char const *) const
Definition: String.cc:285
size_type size() const
Definition: SquidString.h:73
#define DBG_IMPORTANT
Definition: Stream.h:41
#define debugs(SECTION, LEVEL, CONTENT)
Definition: Stream.h:196
@ PROTO_ICY
Definition: ProtocolType.h:38
AnyP::ProtocolVersion ProtocolVersion()
Protocol version to use in Http::Message structures wrapping FTP messages.
Definition: Elements.cc:24
StatusCode
Definition: StatusCode.h:20
@ scInternalServerError
Definition: StatusCode.h:71
@ scInvalidHeader
Definition: StatusCode.h:86
@ scNone
Definition: StatusCode.h:21
const char * StatusCodeString(const Http::StatusCode status)
Definition: StatusCode.cc:14
AnyP::ProtocolVersion ProtocolVersion(unsigned int aMajor, unsigned int aMinor)
HTTP version label information.
Definition: parse.c:160
#define xisdigit(x)
Definition: xis.h:20

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors