1 // -*- mode: cpp; mode: fold -*-
3 /* ######################################################################
5 HTTP and HTTPS share a lot of common code and these classes are
6 exactly the dumping ground for this common code
8 ##################################################################### */
10 // Include Files /*{{{*/
13 #include <apt-pkg/configuration.h>
14 #include <apt-pkg/error.h>
15 #include <apt-pkg/fileutl.h>
16 #include <apt-pkg/strutl.h>
38 string
ServerMethod::FailFile
;
39 int ServerMethod::FailFd
= -1;
40 time_t ServerMethod::FailTime
= 0;
42 // ServerState::RunHeaders - Get the headers before the data /*{{{*/
43 // ---------------------------------------------------------------------
44 /* Returns 0 if things are OK, 1 if an IO error occurred and 2 if a header
45 parse error occurred */
46 ServerState::RunHeadersResult
ServerState::RunHeaders(FileFd
* const File
,
47 const std::string
&Uri
)
51 Owner
->Status(_("Waiting for headers"));
66 if (ReadHeaderLines(Data
) == false)
69 if (Owner
->Debug
== true)
70 clog
<< "Answer for: " << Uri
<< endl
<< Data
;
72 for (string::const_iterator I
= Data
.begin(); I
< Data
.end(); ++I
)
74 string::const_iterator J
= I
;
75 for (; J
!= Data
.end() && *J
!= '\n' && *J
!= '\r'; ++J
);
76 if (HeaderLine(string(I
,J
)) == false)
77 return RUN_HEADERS_PARSE_ERROR
;
81 // 100 Continue is a Nop...
85 // Tidy up the connection persistence state.
86 if (Encoding
== Closes
&& HaveContent
== true)
89 return RUN_HEADERS_OK
;
91 while (LoadNextResponse(false, File
) == true);
93 return RUN_HEADERS_IO_ERROR
;
96 // ServerState::HeaderLine - Process a header line /*{{{*/
97 // ---------------------------------------------------------------------
99 bool ServerState::HeaderLine(string Line
)
101 if (Line
.empty() == true)
104 string::size_type Pos
= Line
.find(' ');
105 if (Pos
== string::npos
|| Pos
+1 > Line
.length())
107 // Blah, some servers use "connection:closes", evil.
108 Pos
= Line
.find(':');
109 if (Pos
== string::npos
|| Pos
+ 2 > Line
.length())
110 return _error
->Error(_("Bad header line"));
114 // Parse off any trailing spaces between the : and the next word.
115 string::size_type Pos2
= Pos
;
116 while (Pos2
< Line
.length() && isspace_ascii(Line
[Pos2
]) != 0)
119 string Tag
= string(Line
,0,Pos
);
120 string Val
= string(Line
,Pos2
);
122 if (stringcasecmp(Tag
.c_str(),Tag
.c_str()+4,"HTTP") == 0)
124 // Evil servers return no version
127 int const elements
= sscanf(Line
.c_str(),"HTTP/%3u.%3u %3u%359[^\n]",&Major
,&Minor
,&Result
,Code
);
131 if (Owner
!= NULL
&& Owner
->Debug
== true)
132 clog
<< "HTTP server doesn't give Reason-Phrase for " << std::to_string(Result
) << std::endl
;
134 else if (elements
!= 4)
135 return _error
->Error(_("The HTTP server sent an invalid reply header"));
141 if (sscanf(Line
.c_str(),"HTTP %3u%359[^\n]",&Result
,Code
) != 2)
142 return _error
->Error(_("The HTTP server sent an invalid reply header"));
145 /* Check the HTTP response header to get the default persistence
151 if (Major
== 1 && Minor
== 0)
166 if (stringcasecmp(Tag
,"Content-Length:") == 0)
168 if (Encoding
== Closes
)
172 unsigned long long * DownloadSizePtr
= &DownloadSize
;
174 DownloadSizePtr
= &JunkSize
;
176 *DownloadSizePtr
= strtoull(Val
.c_str(), NULL
, 10);
177 if (*DownloadSizePtr
>= std::numeric_limits
<unsigned long long>::max())
178 return _error
->Errno("HeaderLine", _("The HTTP server sent an invalid Content-Length header"));
179 else if (*DownloadSizePtr
== 0)
182 // On partial content (206) the Content-Length less than the real
183 // size, so do not set it here but leave that to the Content-Range
185 if(Result
!= 206 && TotalFileSize
== 0)
186 TotalFileSize
= DownloadSize
;
191 if (stringcasecmp(Tag
,"Content-Type:") == 0)
197 if (stringcasecmp(Tag
,"Content-Range:") == 0)
201 // §14.16 says 'byte-range-resp-spec' should be a '*' in case of 416
202 if (Result
== 416 && sscanf(Val
.c_str(), "bytes */%llu",&TotalFileSize
) == 1)
203 ; // we got the expected filesize which is all we wanted
204 else if (sscanf(Val
.c_str(),"bytes %llu-%*u/%llu",&StartPos
,&TotalFileSize
) != 2)
205 return _error
->Error(_("The HTTP server sent an invalid Content-Range header"));
206 if ((unsigned long long)StartPos
> TotalFileSize
)
207 return _error
->Error(_("This HTTP server has broken range support"));
209 // figure out what we will download
210 DownloadSize
= TotalFileSize
- StartPos
;
214 if (stringcasecmp(Tag
,"Transfer-Encoding:") == 0)
217 if (stringcasecmp(Val
,"chunked") == 0)
222 if (stringcasecmp(Tag
,"Connection:") == 0)
224 if (stringcasecmp(Val
,"close") == 0)
226 if (stringcasecmp(Val
,"keep-alive") == 0)
231 if (stringcasecmp(Tag
,"Last-Modified:") == 0)
233 if (RFC1123StrToTime(Val
.c_str(), Date
) == false)
234 return _error
->Error(_("Unknown date format"));
238 if (stringcasecmp(Tag
,"Location:") == 0)
247 // ServerState::ServerState - Constructor /*{{{*/
248 ServerState::ServerState(URI Srv
, ServerMethod
*Owner
) :
249 DownloadSize(0), ServerName(Srv
), TimeOut(120), Owner(Owner
)
254 bool ServerState::AddPartialFileToHashes(FileFd
&File
) /*{{{*/
256 File
.Truncate(StartPos
);
257 return GetHashes()->AddFD(File
, StartPos
);
261 // ServerMethod::DealWithHeaders - Handle the retrieved header data /*{{{*/
262 // ---------------------------------------------------------------------
263 /* We look at the header data we got back from the server and decide what
264 to do. Returns DealWithHeadersResult (see http.h for details).
266 ServerMethod::DealWithHeadersResult
267 ServerMethod::DealWithHeaders(FetchResult
&Res
)
270 if (Server
->Result
== 304)
272 RemoveFile("server", Queue
->DestFile
);
274 Res
.LastModified
= Queue
->LastModified
;
280 * Note that it is only OK for us to treat all redirection the same
281 * because we *always* use GET, not other HTTP methods. There are
282 * three redirection codes for which it is not appropriate that we
283 * redirect. Pass on those codes so the error handling kicks in.
286 && (Server
->Result
> 300 && Server
->Result
< 400)
287 && (Server
->Result
!= 300 // Multiple Choices
288 && Server
->Result
!= 304 // Not Modified
289 && Server
->Result
!= 306)) // (Not part of HTTP/1.1, reserved)
291 if (Server
->Location
.empty() == true);
292 else if (Server
->Location
[0] == '/' && Queue
->Uri
.empty() == false)
294 URI Uri
= Queue
->Uri
;
295 if (Uri
.Host
.empty() == false)
296 NextURI
= URI::SiteOnly(Uri
);
299 NextURI
.append(DeQuoteString(Server
->Location
));
300 return TRY_AGAIN_OR_REDIRECT
;
304 NextURI
= DeQuoteString(Server
->Location
);
305 URI tmpURI
= NextURI
;
306 URI Uri
= Queue
->Uri
;
307 // same protocol redirects are okay
308 if (tmpURI
.Access
== Uri
.Access
)
309 return TRY_AGAIN_OR_REDIRECT
;
310 // as well as http to https
311 else if (Uri
.Access
== "http" && tmpURI
.Access
== "https")
312 return TRY_AGAIN_OR_REDIRECT
;
314 /* else pass through for error message */
316 // retry after an invalid range response without partial data
317 else if (Server
->Result
== 416)
320 if (stat(Queue
->DestFile
.c_str(),&SBuf
) >= 0 && SBuf
.st_size
> 0)
322 bool partialHit
= false;
323 if (Queue
->ExpectedHashes
.usable() == true)
325 Hashes
resultHashes(Queue
->ExpectedHashes
);
326 FileFd
file(Queue
->DestFile
, FileFd::ReadOnly
);
327 Server
->TotalFileSize
= file
.FileSize();
328 Server
->Date
= file
.ModificationTime();
329 resultHashes
.AddFD(file
);
330 HashStringList
const hashList
= resultHashes
.GetHashStringList();
331 partialHit
= (Queue
->ExpectedHashes
== hashList
);
333 else if ((unsigned long long)SBuf
.st_size
== Server
->TotalFileSize
)
335 if (partialHit
== true)
337 // the file is completely downloaded, but was not moved
338 if (Server
->HaveContent
== true)
340 // Send to error page to dev/null
341 FileFd
DevNull("/dev/null",FileFd::WriteExists
);
342 Server
->RunData(&DevNull
);
344 Server
->HaveContent
= false;
345 Server
->StartPos
= Server
->TotalFileSize
;
346 Server
->Result
= 200;
348 else if (RemoveFile("server", Queue
->DestFile
))
350 NextURI
= Queue
->Uri
;
351 return TRY_AGAIN_OR_REDIRECT
;
356 /* We have a reply we don't handle. This should indicate a perm server
358 if (Server
->Result
< 200 || Server
->Result
>= 300)
361 strprintf(err
, "HttpError%u", Server
->Result
);
363 _error
->Error("%u %s", Server
->Result
, Server
->Code
);
364 if (Server
->HaveContent
== true)
365 return ERROR_WITH_CONTENT_PAGE
;
366 return ERROR_UNRECOVERABLE
;
369 // This is some sort of 2xx 'data follows' reply
370 Res
.LastModified
= Server
->Date
;
371 Res
.Size
= Server
->TotalFileSize
;
375 File
= new FileFd(Queue
->DestFile
,FileFd::WriteAny
);
376 if (_error
->PendingError() == true)
377 return ERROR_NOT_FROM_SERVER
;
379 FailFile
= Queue
->DestFile
;
380 FailFile
.c_str(); // Make sure we don't do a malloc in the signal handler
382 FailTime
= Server
->Date
;
384 if (Server
->InitHashes(Queue
->ExpectedHashes
) == false || Server
->AddPartialFileToHashes(*File
) == false)
386 _error
->Errno("read",_("Problem hashing file"));
387 return ERROR_NOT_FROM_SERVER
;
389 if (Server
->StartPos
> 0)
390 Res
.ResumePoint
= Server
->StartPos
;
392 SetNonBlock(File
->Fd(),true);
396 // ServerMethod::SigTerm - Handle a fatal signal /*{{{*/
397 // ---------------------------------------------------------------------
398 /* This closes and timestamps the open file. This is necessary to get
399 resume behavoir on user abort */
400 void ServerMethod::SigTerm(int)
405 struct timeval times
[2];
406 times
[0].tv_sec
= FailTime
;
407 times
[1].tv_sec
= FailTime
;
408 times
[0].tv_usec
= times
[1].tv_usec
= 0;
409 utimes(FailFile
.c_str(), times
);
415 // ServerMethod::Fetch - Fetch an item /*{{{*/
416 // ---------------------------------------------------------------------
417 /* This adds an item to the pipeline. We keep the pipeline at a fixed
419 bool ServerMethod::Fetch(FetchItem
*)
421 if (Server
== nullptr || QueueBack
== nullptr)
424 // If pipelining is disabled, we only queue 1 request
425 auto const AllowedDepth
= Server
->Pipeline
? PipelineDepth
: 0;
426 // how deep is our pipeline currently?
427 decltype(PipelineDepth
) CurrentDepth
= 0;
428 for (FetchItem
const *I
= Queue
; I
!= QueueBack
; I
= I
->Next
)
432 // Make sure we stick with the same server
433 if (Server
->Comp(QueueBack
->Uri
) == false)
436 bool const UsableHashes
= QueueBack
->ExpectedHashes
.usable();
437 // if we have no hashes, do at most one such request
438 // as we can't fixup pipeling misbehaviors otherwise
439 if (CurrentDepth
!= 0 && UsableHashes
== false)
442 if (UsableHashes
&& FileExists(QueueBack
->DestFile
))
444 FileFd
partial(QueueBack
->DestFile
, FileFd::ReadOnly
);
445 Hashes
wehave(QueueBack
->ExpectedHashes
);
446 if (QueueBack
->ExpectedHashes
.FileSize() == partial
.FileSize())
448 if (wehave
.AddFD(partial
) &&
449 wehave
.GetHashStringList() == QueueBack
->ExpectedHashes
)
452 Res
.Filename
= QueueBack
->DestFile
;
453 Res
.ResumePoint
= QueueBack
->ExpectedHashes
.FileSize();
455 // move item to the start of the queue as URIDone will
456 // always dequeued the first item in the queue
457 if (Queue
!= QueueBack
)
459 FetchItem
*Prev
= Queue
;
460 for (; Prev
->Next
!= QueueBack
; Prev
= Prev
->Next
)
461 /* look for the previous queue item */;
462 Prev
->Next
= QueueBack
->Next
;
463 QueueBack
->Next
= Queue
;
465 QueueBack
= Prev
->Next
;
467 Res
.TakeHashes(wehave
);
472 RemoveFile("Fetch-Partial", QueueBack
->DestFile
);
475 auto const Tmp
= QueueBack
;
476 QueueBack
= QueueBack
->Next
;
479 } while (CurrentDepth
<= AllowedDepth
&& QueueBack
!= nullptr);
484 // ServerMethod::Loop - Main loop /*{{{*/
485 int ServerMethod::Loop()
487 typedef vector
<string
> StringVector
;
488 typedef vector
<string
>::iterator StringVectorIterator
;
489 map
<string
, StringVector
> Redirected
;
491 signal(SIGTERM
,SigTerm
);
492 signal(SIGINT
,SigTerm
);
499 // We have no commands, wait for some to arrive
502 if (WaitFd(STDIN_FILENO
) == false)
506 /* Run messages, we can accept 0 (no message) if we didn't
507 do a WaitFd above.. Otherwise the FD is closed. */
508 int Result
= Run(true);
509 if (Result
!= -1 && (Result
!= 0 || Queue
== 0))
511 if(FailReason
.empty() == false ||
512 _config
->FindB("Acquire::http::DependOnSTDIN", true) == true)
521 // Connect to the server
522 if (Server
== 0 || Server
->Comp(Queue
->Uri
) == false)
523 Server
= CreateServerState(Queue
->Uri
);
525 /* If the server has explicitly said this is the last connection
526 then we pre-emptively shut down the pipeline and tear down
527 the connection. This will speed up HTTP/1.0 servers a tad
528 since we don't have to wait for the close sequence to
530 if (Server
->Persistent
== false)
533 // Reset the pipeline
534 if (Server
->IsOpen() == false)
537 // Connnect to the host
538 if (Server
->Open() == false)
545 // Fill the pipeline.
548 // Fetch the next URL header data from the server.
549 switch (Server
->RunHeaders(File
, Queue
->Uri
))
551 case ServerState::RUN_HEADERS_OK
:
554 // The header data is bad
555 case ServerState::RUN_HEADERS_PARSE_ERROR
:
557 _error
->Error(_("Bad header data"));
563 // The server closed a connection during the header get..
565 case ServerState::RUN_HEADERS_IO_ERROR
:
570 Server
->Pipeline
= false;
571 Server
->PipelineAllowed
= false;
573 if (FailCounter
>= 2)
575 Fail(_("Connection failed"),true);
584 // Decide what to do.
586 Res
.Filename
= Queue
->DestFile
;
587 switch (DealWithHeaders(Res
))
589 // Ok, the file is Open
597 // ensure we don't fetch too much
598 // we could do "Server->MaximumSize = Queue->MaximumSize" here
599 // but that would break the clever pipeline messup detection
600 // so instead we use the size of the biggest item in the queue
601 Server
->MaximumSize
= FindMaximumObjectSizeInQueue();
603 if (Server
->HaveContent
)
604 Result
= Server
->RunData(File
);
606 /* If the server is sending back sizeless responses then fill in
609 Res
.Size
= File
->Size();
611 // Close the file, destroy the FD object and timestamp it
617 struct timeval times
[2];
618 times
[0].tv_sec
= times
[1].tv_sec
= Server
->Date
;
619 times
[0].tv_usec
= times
[1].tv_usec
= 0;
620 utimes(Queue
->DestFile
.c_str(), times
);
622 // Send status to APT
625 Hashes
* const resultHashes
= Server
->GetHashes();
626 HashStringList
const hashList
= resultHashes
->GetHashStringList();
627 if (PipelineDepth
!= 0 && Queue
->ExpectedHashes
.usable() == true && Queue
->ExpectedHashes
!= hashList
)
629 // we did not get the expected hash… mhhh:
630 // could it be that server/proxy messed up pipelining?
631 FetchItem
* BeforeI
= Queue
;
632 for (FetchItem
*I
= Queue
->Next
; I
!= 0 && I
!= QueueBack
; I
= I
->Next
)
634 if (I
->ExpectedHashes
.usable() == true && I
->ExpectedHashes
== hashList
)
636 // yes, he did! Disable pipelining and rewrite queue
637 if (Server
->Pipeline
== true)
639 // FIXME: fake a warning message as we have no proper way of communicating here
641 strprintf(out
, _("Automatically disabled %s due to incorrect response from server/proxy. (man 5 apt.conf)"), "Acquire::http::PipelineDepth");
642 std::cerr
<< "W: " << out
<< std::endl
;
643 Server
->Pipeline
= false;
644 Server
->PipelineAllowed
= false;
645 // we keep the PipelineDepth value so that the rest of the queue can be fixed up as well
647 Rename(Res
.Filename
, I
->DestFile
);
648 Res
.Filename
= I
->DestFile
;
649 BeforeI
->Next
= I
->Next
;
657 Res
.TakeHashes(*resultHashes
);
662 if (Server
->IsOpen() == false)
668 if (FailCounter
>= 2)
670 Fail(_("Connection failed"),true);
692 // Hard server error, not found or something
693 case ERROR_UNRECOVERABLE
:
699 // Hard internal error, kill the connection and fail
700 case ERROR_NOT_FROM_SERVER
:
711 // We need to flush the data, the header is like a 404 w/ error text
712 case ERROR_WITH_CONTENT_PAGE
:
716 // Send to content to dev/null
717 File
= new FileFd("/dev/null",FileFd::WriteExists
);
718 Server
->RunData(File
);
724 // Try again with a new URL
725 case TRY_AGAIN_OR_REDIRECT
:
727 // Clear rest of response if there is content
728 if (Server
->HaveContent
)
730 File
= new FileFd("/dev/null",FileFd::WriteExists
);
731 Server
->RunData(File
);
736 /* Detect redirect loops. No more redirects are allowed
737 after the same URI is seen twice in a queue item. */
738 StringVector
&R
= Redirected
[Queue
->DestFile
];
739 bool StopRedirects
= false;
740 if (R
.empty() == true)
741 R
.push_back(Queue
->Uri
);
742 else if (R
[0] == "STOP" || R
.size() > 10)
743 StopRedirects
= true;
746 for (StringVectorIterator I
= R
.begin(); I
!= R
.end(); ++I
)
747 if (Queue
->Uri
== *I
)
753 R
.push_back(Queue
->Uri
);
756 if (StopRedirects
== false)
765 Fail(_("Internal error"));
775 unsigned long long ServerMethod::FindMaximumObjectSizeInQueue() const /*{{{*/
777 unsigned long long MaxSizeInQueue
= 0;
778 for (FetchItem
*I
= Queue
; I
!= 0 && I
!= QueueBack
; I
= I
->Next
)
779 MaxSizeInQueue
= std::max(MaxSizeInQueue
, I
->MaximumSize
);
780 return MaxSizeInQueue
;
783 ServerMethod::ServerMethod(char const * const Binary
, char const * const Ver
,unsigned long const Flags
) :/*{{{*/
784 aptMethod(Binary
, Ver
, Flags
), Server(nullptr), File(NULL
), PipelineDepth(10),
785 AllowRedirect(false), Debug(false)