]> sjero.net Git - wget/blob - src/http.c
Fix crash when receiving a HTTP redirect upon a POST request
[wget] / src / http.c
1 /* HTTP support.
2    Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
3    2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 Free Software Foundation,
4    Inc.
5
6 This file is part of GNU Wget.
7
8 GNU Wget is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11  (at your option) any later version.
12
13 GNU Wget is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with Wget.  If not, see <http://www.gnu.org/licenses/>.
20
21 Additional permission under GNU GPL version 3 section 7
22
23 If you modify this program, or any covered work, by linking or
24 combining it with the OpenSSL project's OpenSSL library (or a
25 modified version of that library), containing parts covered by the
26 terms of the OpenSSL or SSLeay licenses, the Free Software Foundation
27 grants you additional permission to convey the resulting work.
28 Corresponding Source for a non-source form of such a combination
29 shall include the source code for the parts of OpenSSL used as well
30 as that of the covered work.  */
31
32 #include "wget.h"
33
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <unistd.h>
38 #include <assert.h>
39 #include <errno.h>
40 #include <time.h>
41 #include <locale.h>
42
43 #include "hash.h"
44 #include "http.h"
45 #include "utils.h"
46 #include "url.h"
47 #include "host.h"
48 #include "retr.h"
49 #include "connect.h"
50 #include "netrc.h"
51 #ifdef HAVE_SSL
52 # include "ssl.h"
53 #endif
54 #ifdef ENABLE_NTLM
55 # include "http-ntlm.h"
56 #endif
57 #include "cookies.h"
58 #include "md5.h"
59 #include "convert.h"
60 #include "spider.h"
61 #include "warc.h"
62
63 #ifdef TESTING
64 #include "test.h"
65 #endif
66
67 #ifdef __VMS
68 # include "vms.h"
69 #endif /* def __VMS */
70
71 extern char *version_string;
72
73 /* Forward decls. */
74 struct http_stat;
75 static char *create_authorization_line (const char *, const char *,
76                                         const char *, const char *,
77                                         const char *, bool *);
78 static char *basic_authentication_encode (const char *, const char *);
79 static bool known_authentication_scheme_p (const char *, const char *);
80 static void ensure_extension (struct http_stat *, const char *, int *);
81 static void load_cookies (void);
82
83 #ifndef MIN
84 # define MIN(x, y) ((x) > (y) ? (y) : (x))
85 #endif
86
87 \f
88 static bool cookies_loaded_p;
89 static struct cookie_jar *wget_cookie_jar;
90
91 #define TEXTHTML_S "text/html"
92 #define TEXTXHTML_S "application/xhtml+xml"
93 #define TEXTCSS_S "text/css"
94
95 /* Some status code validation macros: */
96 #define H_10X(x)        (((x) >= 100) && ((x) < 200))
97 #define H_20X(x)        (((x) >= 200) && ((x) < 300))
98 #define H_PARTIAL(x)    ((x) == HTTP_STATUS_PARTIAL_CONTENTS)
99 #define H_REDIRECTED(x) ((x) == HTTP_STATUS_MOVED_PERMANENTLY          \
100                          || (x) == HTTP_STATUS_MOVED_TEMPORARILY       \
101                          || (x) == HTTP_STATUS_SEE_OTHER               \
102                          || (x) == HTTP_STATUS_TEMPORARY_REDIRECT)
103
104 /* HTTP/1.0 status codes from RFC1945, provided for reference.  */
105 /* Successful 2xx.  */
106 #define HTTP_STATUS_OK                    200
107 #define HTTP_STATUS_CREATED               201
108 #define HTTP_STATUS_ACCEPTED              202
109 #define HTTP_STATUS_NO_CONTENT            204
110 #define HTTP_STATUS_PARTIAL_CONTENTS      206
111
112 /* Redirection 3xx.  */
113 #define HTTP_STATUS_MULTIPLE_CHOICES      300
114 #define HTTP_STATUS_MOVED_PERMANENTLY     301
115 #define HTTP_STATUS_MOVED_TEMPORARILY     302
116 #define HTTP_STATUS_SEE_OTHER             303 /* from HTTP/1.1 */
117 #define HTTP_STATUS_NOT_MODIFIED          304
118 #define HTTP_STATUS_TEMPORARY_REDIRECT    307 /* from HTTP/1.1 */
119
120 /* Client error 4xx.  */
121 #define HTTP_STATUS_BAD_REQUEST           400
122 #define HTTP_STATUS_UNAUTHORIZED          401
123 #define HTTP_STATUS_FORBIDDEN             403
124 #define HTTP_STATUS_NOT_FOUND             404
125 #define HTTP_STATUS_RANGE_NOT_SATISFIABLE 416
126
127 /* Server errors 5xx.  */
128 #define HTTP_STATUS_INTERNAL              500
129 #define HTTP_STATUS_NOT_IMPLEMENTED       501
130 #define HTTP_STATUS_BAD_GATEWAY           502
131 #define HTTP_STATUS_UNAVAILABLE           503
132 \f
133 enum rp {
134   rel_none, rel_name, rel_value, rel_both
135 };
136
137 struct request {
138   const char *method;
139   char *arg;
140
141   struct request_header {
142     char *name, *value;
143     enum rp release_policy;
144   } *headers;
145   int hcount, hcapacity;
146 };
147
148 extern int numurls;
149
150 /* Create a new, empty request.  At least request_set_method must be
151    called before the request can be used.  */
152
153 static struct request *
154 request_new (void)
155 {
156   struct request *req = xnew0 (struct request);
157   req->hcapacity = 8;
158   req->headers = xnew_array (struct request_header, req->hcapacity);
159   return req;
160 }
161
162 /* Set the request's method and its arguments.  METH should be a
163    literal string (or it should outlive the request) because it will
164    not be freed.  ARG will be freed by request_free.  */
165
166 static void
167 request_set_method (struct request *req, const char *meth, char *arg)
168 {
169   req->method = meth;
170   req->arg = arg;
171 }
172
173 /* Return the method string passed with the last call to
174    request_set_method.  */
175
176 static const char *
177 request_method (const struct request *req)
178 {
179   return req->method;
180 }
181
182 /* Free one header according to the release policy specified with
183    request_set_header.  */
184
185 static void
186 release_header (struct request_header *hdr)
187 {
188   switch (hdr->release_policy)
189     {
190     case rel_none:
191       break;
192     case rel_name:
193       xfree (hdr->name);
194       break;
195     case rel_value:
196       xfree (hdr->value);
197       break;
198     case rel_both:
199       xfree (hdr->name);
200       xfree (hdr->value);
201       break;
202     }
203 }
204
205 /* Set the request named NAME to VALUE.  Specifically, this means that
206    a "NAME: VALUE\r\n" header line will be used in the request.  If a
207    header with the same name previously existed in the request, its
208    value will be replaced by this one.  A NULL value means do nothing.
209
210    RELEASE_POLICY determines whether NAME and VALUE should be released
211    (freed) with request_free.  Allowed values are:
212
213     - rel_none     - don't free NAME or VALUE
214     - rel_name     - free NAME when done
215     - rel_value    - free VALUE when done
216     - rel_both     - free both NAME and VALUE when done
217
218    Setting release policy is useful when arguments come from different
219    sources.  For example:
220
221      // Don't free literal strings!
222      request_set_header (req, "Pragma", "no-cache", rel_none);
223
224      // Don't free a global variable, we'll need it later.
225      request_set_header (req, "Referer", opt.referer, rel_none);
226
227      // Value freshly allocated, free it when done.
228      request_set_header (req, "Range",
229                          aprintf ("bytes=%s-", number_to_static_string (hs->restval)),
230                          rel_value);
231    */
232
233 static void
234 request_set_header (struct request *req, const char *name, const char *value,
235                     enum rp release_policy)
236 {
237   struct request_header *hdr;
238   int i;
239
240   if (!value)
241     {
242       /* A NULL value is a no-op; if freeing the name is requested,
243          free it now to avoid leaks.  */
244       if (release_policy == rel_name || release_policy == rel_both)
245         xfree ((void *)name);
246       return;
247     }
248
249   for (i = 0; i < req->hcount; i++)
250     {
251       hdr = &req->headers[i];
252       if (0 == strcasecmp (name, hdr->name))
253         {
254           /* Replace existing header. */
255           release_header (hdr);
256           hdr->name = (void *)name;
257           hdr->value = (void *)value;
258           hdr->release_policy = release_policy;
259           return;
260         }
261     }
262
263   /* Install new header. */
264
265   if (req->hcount >= req->hcapacity)
266     {
267       req->hcapacity <<= 1;
268       req->headers = xrealloc (req->headers, req->hcapacity * sizeof (*hdr));
269     }
270   hdr = &req->headers[req->hcount++];
271   hdr->name = (void *)name;
272   hdr->value = (void *)value;
273   hdr->release_policy = release_policy;
274 }
275
276 /* Like request_set_header, but sets the whole header line, as
277    provided by the user using the `--header' option.  For example,
278    request_set_user_header (req, "Foo: bar") works just like
279    request_set_header (req, "Foo", "bar").  */
280
281 static void
282 request_set_user_header (struct request *req, const char *header)
283 {
284   char *name;
285   const char *p = strchr (header, ':');
286   if (!p)
287     return;
288   BOUNDED_TO_ALLOCA (header, p, name);
289   ++p;
290   while (c_isspace (*p))
291     ++p;
292   request_set_header (req, xstrdup (name), (char *) p, rel_name);
293 }
294
295 /* Remove the header with specified name from REQ.  Returns true if
296    the header was actually removed, false otherwise.  */
297
298 static bool
299 request_remove_header (struct request *req, const char *name)
300 {
301   int i;
302   for (i = 0; i < req->hcount; i++)
303     {
304       struct request_header *hdr = &req->headers[i];
305       if (0 == strcasecmp (name, hdr->name))
306         {
307           release_header (hdr);
308           /* Move the remaining headers by one. */
309           if (i < req->hcount - 1)
310             memmove (hdr, hdr + 1, (req->hcount - i - 1) * sizeof (*hdr));
311           --req->hcount;
312           return true;
313         }
314     }
315   return false;
316 }
317
318 #define APPEND(p, str) do {                     \
319   int A_len = strlen (str);                     \
320   memcpy (p, str, A_len);                       \
321   p += A_len;                                   \
322 } while (0)
323
324 /* Construct the request and write it to FD using fd_write.
325    If warc_tmp is set to a file pointer, the request string will
326    also be written to that file. */
327
328 static int
329 request_send (const struct request *req, int fd, FILE *warc_tmp)
330 {
331   char *request_string, *p;
332   int i, size, write_error;
333
334   /* Count the request size. */
335   size = 0;
336
337   /* METHOD " " ARG " " "HTTP/1.0" "\r\n" */
338   size += strlen (req->method) + 1 + strlen (req->arg) + 1 + 8 + 2;
339
340   for (i = 0; i < req->hcount; i++)
341     {
342       struct request_header *hdr = &req->headers[i];
343       /* NAME ": " VALUE "\r\n" */
344       size += strlen (hdr->name) + 2 + strlen (hdr->value) + 2;
345     }
346
347   /* "\r\n\0" */
348   size += 3;
349
350   p = request_string = alloca_array (char, size);
351
352   /* Generate the request. */
353
354   APPEND (p, req->method); *p++ = ' ';
355   APPEND (p, req->arg);    *p++ = ' ';
356   memcpy (p, "HTTP/1.1\r\n", 10); p += 10;
357
358   for (i = 0; i < req->hcount; i++)
359     {
360       struct request_header *hdr = &req->headers[i];
361       APPEND (p, hdr->name);
362       *p++ = ':', *p++ = ' ';
363       APPEND (p, hdr->value);
364       *p++ = '\r', *p++ = '\n';
365     }
366
367   *p++ = '\r', *p++ = '\n', *p++ = '\0';
368   assert (p - request_string == size);
369
370 #undef APPEND
371
372   DEBUGP (("\n---request begin---\n%s---request end---\n", request_string));
373
374   /* Send the request to the server. */
375
376   write_error = fd_write (fd, request_string, size - 1, -1);
377   if (write_error < 0)
378     logprintf (LOG_VERBOSE, _("Failed writing HTTP request: %s.\n"),
379                fd_errstr (fd));
380   else if (warc_tmp != NULL)
381     {
382       /* Write a copy of the data to the WARC record. */
383       int warc_tmp_written = fwrite (request_string, 1, size - 1, warc_tmp);
384       if (warc_tmp_written != size - 1)
385         return -2;
386     }
387   return write_error;
388 }
389
390 /* Release the resources used by REQ. */
391
392 static void
393 request_free (struct request *req)
394 {
395   int i;
396   xfree_null (req->arg);
397   for (i = 0; i < req->hcount; i++)
398     release_header (&req->headers[i]);
399   xfree_null (req->headers);
400   xfree (req);
401 }
402
403 static struct hash_table *basic_authed_hosts;
404
405 /* Find out if this host has issued a Basic challenge yet; if so, give
406  * it the username, password. A temporary measure until we can get
407  * proper authentication in place. */
408
409 static bool
410 maybe_send_basic_creds (const char *hostname, const char *user,
411                         const char *passwd, struct request *req)
412 {
413   bool do_challenge = false;
414
415   if (opt.auth_without_challenge)
416     {
417       DEBUGP (("Auth-without-challenge set, sending Basic credentials.\n"));
418       do_challenge = true;
419     }
420   else if (basic_authed_hosts
421       && hash_table_contains(basic_authed_hosts, hostname))
422     {
423       DEBUGP (("Found %s in basic_authed_hosts.\n", quote (hostname)));
424       do_challenge = true;
425     }
426   else
427     {
428       DEBUGP (("Host %s has not issued a general basic challenge.\n",
429               quote (hostname)));
430     }
431   if (do_challenge)
432     {
433       request_set_header (req, "Authorization",
434                           basic_authentication_encode (user, passwd),
435                           rel_value);
436     }
437   return do_challenge;
438 }
439
440 static void
441 register_basic_auth_host (const char *hostname)
442 {
443   if (!basic_authed_hosts)
444     {
445       basic_authed_hosts = make_nocase_string_hash_table (1);
446     }
447   if (!hash_table_contains(basic_authed_hosts, hostname))
448     {
449       hash_table_put (basic_authed_hosts, xstrdup(hostname), NULL);
450       DEBUGP (("Inserted %s into basic_authed_hosts\n", quote (hostname)));
451     }
452 }
453
454
455 /* Send the contents of FILE_NAME to SOCK.  Make sure that exactly
456    PROMISED_SIZE bytes are sent over the wire -- if the file is
457    longer, read only that much; if the file is shorter, report an error.
458    If warc_tmp is set to a file pointer, the post data will
459    also be written to that file.  */
460
461 static int
462 body_file_send (int sock, const char *file_name, wgint promised_size, FILE *warc_tmp)
463 {
464   static char chunk[8192];
465   wgint written = 0;
466   int write_error;
467   FILE *fp;
468
469   DEBUGP (("[writing BODY file %s ... ", file_name));
470
471   fp = fopen (file_name, "rb");
472   if (!fp)
473     return -1;
474   while (!feof (fp) && written < promised_size)
475     {
476       int towrite;
477       int length = fread (chunk, 1, sizeof (chunk), fp);
478       if (length == 0)
479         break;
480       towrite = MIN (promised_size - written, length);
481       write_error = fd_write (sock, chunk, towrite, -1);
482       if (write_error < 0)
483         {
484           fclose (fp);
485           return -1;
486         }
487       if (warc_tmp != NULL)
488         {
489           /* Write a copy of the data to the WARC record. */
490           int warc_tmp_written = fwrite (chunk, 1, towrite, warc_tmp);
491           if (warc_tmp_written != towrite)
492             {
493               fclose (fp);
494               return -2;
495             }
496         }
497       written += towrite;
498     }
499   fclose (fp);
500
501   /* If we've written less than was promised, report a (probably
502      nonsensical) error rather than break the promise.  */
503   if (written < promised_size)
504     {
505       errno = EINVAL;
506       return -1;
507     }
508
509   assert (written == promised_size);
510   DEBUGP (("done]\n"));
511   return 0;
512 }
513 \f
514 /* Determine whether [START, PEEKED + PEEKLEN) contains an empty line.
515    If so, return the pointer to the position after the line, otherwise
516    return NULL.  This is used as callback to fd_read_hunk.  The data
517    between START and PEEKED has been read and cannot be "unread"; the
518    data after PEEKED has only been peeked.  */
519
520 static const char *
521 response_head_terminator (const char *start, const char *peeked, int peeklen)
522 {
523   const char *p, *end;
524
525   /* If at first peek, verify whether HUNK starts with "HTTP".  If
526      not, this is a HTTP/0.9 request and we must bail out without
527      reading anything.  */
528   if (start == peeked && 0 != memcmp (start, "HTTP", MIN (peeklen, 4)))
529     return start;
530
531   /* Look for "\n[\r]\n", and return the following position if found.
532      Start two chars before the current to cover the possibility that
533      part of the terminator (e.g. "\n\r") arrived in the previous
534      batch.  */
535   p = peeked - start < 2 ? start : peeked - 2;
536   end = peeked + peeklen;
537
538   /* Check for \n\r\n or \n\n anywhere in [p, end-2). */
539   for (; p < end - 2; p++)
540     if (*p == '\n')
541       {
542         if (p[1] == '\r' && p[2] == '\n')
543           return p + 3;
544         else if (p[1] == '\n')
545           return p + 2;
546       }
547   /* p==end-2: check for \n\n directly preceding END. */
548   if (p[0] == '\n' && p[1] == '\n')
549     return p + 2;
550
551   return NULL;
552 }
553
554 /* The maximum size of a single HTTP response we care to read.  Rather
555    than being a limit of the reader implementation, this limit
556    prevents Wget from slurping all available memory upon encountering
557    malicious or buggy server output, thus protecting the user.  Define
558    it to 0 to remove the limit.  */
559
560 #define HTTP_RESPONSE_MAX_SIZE 65536
561
562 /* Read the HTTP request head from FD and return it.  The error
563    conditions are the same as with fd_read_hunk.
564
565    To support HTTP/0.9 responses, this function tries to make sure
566    that the data begins with "HTTP".  If this is not the case, no data
567    is read and an empty request is returned, so that the remaining
568    data can be treated as body.  */
569
570 static char *
571 read_http_response_head (int fd)
572 {
573   return fd_read_hunk (fd, response_head_terminator, 512,
574                        HTTP_RESPONSE_MAX_SIZE);
575 }
576
577 struct response {
578   /* The response data. */
579   const char *data;
580
581   /* The array of pointers that indicate where each header starts.
582      For example, given this HTTP response:
583
584        HTTP/1.0 200 Ok
585        Description: some
586         text
587        Etag: x
588
589      The headers are located like this:
590
591      "HTTP/1.0 200 Ok\r\nDescription: some\r\n text\r\nEtag: x\r\n\r\n"
592      ^                   ^                             ^          ^
593      headers[0]          headers[1]                    headers[2] headers[3]
594
595      I.e. headers[0] points to the beginning of the request,
596      headers[1] points to the end of the first header and the
597      beginning of the second one, etc.  */
598
599   const char **headers;
600 };
601
602 /* Create a new response object from the text of the HTTP response,
603    available in HEAD.  That text is automatically split into
604    constituent header lines for fast retrieval using
605    resp_header_*.  */
606
607 static struct response *
608 resp_new (const char *head)
609 {
610   const char *hdr;
611   int count, size;
612
613   struct response *resp = xnew0 (struct response);
614   resp->data = head;
615
616   if (*head == '\0')
617     {
618       /* Empty head means that we're dealing with a headerless
619          (HTTP/0.9) response.  In that case, don't set HEADERS at
620          all.  */
621       return resp;
622     }
623
624   /* Split HEAD into header lines, so that resp_header_* functions
625      don't need to do this over and over again.  */
626
627   size = count = 0;
628   hdr = head;
629   while (1)
630     {
631       DO_REALLOC (resp->headers, size, count + 1, const char *);
632       resp->headers[count++] = hdr;
633
634       /* Break upon encountering an empty line. */
635       if (!hdr[0] || (hdr[0] == '\r' && hdr[1] == '\n') || hdr[0] == '\n')
636         break;
637
638       /* Find the end of HDR, including continuations. */
639       do
640         {
641           const char *end = strchr (hdr, '\n');
642           if (end)
643             hdr = end + 1;
644           else
645             hdr += strlen (hdr);
646         }
647       while (*hdr == ' ' || *hdr == '\t');
648     }
649   DO_REALLOC (resp->headers, size, count + 1, const char *);
650   resp->headers[count] = NULL;
651
652   return resp;
653 }
654
655 /* Locate the header named NAME in the request data, starting with
656    position START.  This allows the code to loop through the request
657    data, filtering for all requests of a given name.  Returns the
658    found position, or -1 for failure.  The code that uses this
659    function typically looks like this:
660
661      for (pos = 0; (pos = resp_header_locate (...)) != -1; pos++)
662        ... do something with header ...
663
664    If you only care about one header, use resp_header_get instead of
665    this function.  */
666
667 static int
668 resp_header_locate (const struct response *resp, const char *name, int start,
669                     const char **begptr, const char **endptr)
670 {
671   int i;
672   const char **headers = resp->headers;
673   int name_len;
674
675   if (!headers || !headers[1])
676     return -1;
677
678   name_len = strlen (name);
679   if (start > 0)
680     i = start;
681   else
682     i = 1;
683
684   for (; headers[i + 1]; i++)
685     {
686       const char *b = headers[i];
687       const char *e = headers[i + 1];
688       if (e - b > name_len
689           && b[name_len] == ':'
690           && 0 == strncasecmp (b, name, name_len))
691         {
692           b += name_len + 1;
693           while (b < e && c_isspace (*b))
694             ++b;
695           while (b < e && c_isspace (e[-1]))
696             --e;
697           *begptr = b;
698           *endptr = e;
699           return i;
700         }
701     }
702   return -1;
703 }
704
705 /* Find and retrieve the header named NAME in the request data.  If
706    found, set *BEGPTR to its starting, and *ENDPTR to its ending
707    position, and return true.  Otherwise return false.
708
709    This function is used as a building block for resp_header_copy
710    and resp_header_strdup.  */
711
712 static bool
713 resp_header_get (const struct response *resp, const char *name,
714                  const char **begptr, const char **endptr)
715 {
716   int pos = resp_header_locate (resp, name, 0, begptr, endptr);
717   return pos != -1;
718 }
719
720 /* Copy the response header named NAME to buffer BUF, no longer than
721    BUFSIZE (BUFSIZE includes the terminating 0).  If the header
722    exists, true is returned, false otherwise.  If there should be no
723    limit on the size of the header, use resp_header_strdup instead.
724
725    If BUFSIZE is 0, no data is copied, but the boolean indication of
726    whether the header is present is still returned.  */
727
728 static bool
729 resp_header_copy (const struct response *resp, const char *name,
730                   char *buf, int bufsize)
731 {
732   const char *b, *e;
733   if (!resp_header_get (resp, name, &b, &e))
734     return false;
735   if (bufsize)
736     {
737       int len = MIN (e - b, bufsize - 1);
738       memcpy (buf, b, len);
739       buf[len] = '\0';
740     }
741   return true;
742 }
743
744 /* Return the value of header named NAME in RESP, allocated with
745    malloc.  If such a header does not exist in RESP, return NULL.  */
746
747 static char *
748 resp_header_strdup (const struct response *resp, const char *name)
749 {
750   const char *b, *e;
751   if (!resp_header_get (resp, name, &b, &e))
752     return NULL;
753   return strdupdelim (b, e);
754 }
755
756 /* Parse the HTTP status line, which is of format:
757
758    HTTP-Version SP Status-Code SP Reason-Phrase
759
760    The function returns the status-code, or -1 if the status line
761    appears malformed.  The pointer to "reason-phrase" message is
762    returned in *MESSAGE.  */
763
764 static int
765 resp_status (const struct response *resp, char **message)
766 {
767   int status;
768   const char *p, *end;
769
770   if (!resp->headers)
771     {
772       /* For a HTTP/0.9 response, assume status 200. */
773       if (message)
774         *message = xstrdup (_("No headers, assuming HTTP/0.9"));
775       return 200;
776     }
777
778   p = resp->headers[0];
779   end = resp->headers[1];
780
781   if (!end)
782     return -1;
783
784   /* "HTTP" */
785   if (end - p < 4 || 0 != strncmp (p, "HTTP", 4))
786     return -1;
787   p += 4;
788
789   /* Match the HTTP version.  This is optional because Gnutella
790      servers have been reported to not specify HTTP version.  */
791   if (p < end && *p == '/')
792     {
793       ++p;
794       while (p < end && c_isdigit (*p))
795         ++p;
796       if (p < end && *p == '.')
797         ++p;
798       while (p < end && c_isdigit (*p))
799         ++p;
800     }
801
802   while (p < end && c_isspace (*p))
803     ++p;
804   if (end - p < 3 || !c_isdigit (p[0]) || !c_isdigit (p[1]) || !c_isdigit (p[2]))
805     return -1;
806
807   status = 100 * (p[0] - '0') + 10 * (p[1] - '0') + (p[2] - '0');
808   p += 3;
809
810   if (message)
811     {
812       while (p < end && c_isspace (*p))
813         ++p;
814       while (p < end && c_isspace (end[-1]))
815         --end;
816       *message = strdupdelim (p, end);
817     }
818
819   return status;
820 }
821
822 /* Release the resources used by RESP.  */
823
824 static void
825 resp_free (struct response *resp)
826 {
827   xfree_null (resp->headers);
828   xfree (resp);
829 }
830
831 /* Print a single line of response, the characters [b, e).  We tried
832    getting away with
833       logprintf (LOG_VERBOSE, "%s%.*s\n", prefix, (int) (e - b), b);
834    but that failed to escape the non-printable characters and, in fact,
835    caused crashes in UTF-8 locales.  */
836
837 static void
838 print_response_line(const char *prefix, const char *b, const char *e)
839 {
840   char *copy;
841   BOUNDED_TO_ALLOCA(b, e, copy);
842   logprintf (LOG_ALWAYS, "%s%s\n", prefix,
843              quotearg_style (escape_quoting_style, copy));
844 }
845
846 /* Print the server response, line by line, omitting the trailing CRLF
847    from individual header lines, and prefixed with PREFIX.  */
848
849 static void
850 print_server_response (const struct response *resp, const char *prefix)
851 {
852   int i;
853   if (!resp->headers)
854     return;
855   for (i = 0; resp->headers[i + 1]; i++)
856     {
857       const char *b = resp->headers[i];
858       const char *e = resp->headers[i + 1];
859       /* Skip CRLF */
860       if (b < e && e[-1] == '\n')
861         --e;
862       if (b < e && e[-1] == '\r')
863         --e;
864       print_response_line(prefix, b, e);
865     }
866 }
867
868 /* Parse the `Content-Range' header and extract the information it
869    contains.  Returns true if successful, false otherwise.  */
870 static bool
871 parse_content_range (const char *hdr, wgint *first_byte_ptr,
872                      wgint *last_byte_ptr, wgint *entity_length_ptr)
873 {
874   wgint num;
875
876   /* Ancient versions of Netscape proxy server, presumably predating
877      rfc2068, sent out `Content-Range' without the "bytes"
878      specifier.  */
879   if (0 == strncasecmp (hdr, "bytes", 5))
880     {
881       hdr += 5;
882       /* "JavaWebServer/1.1.1" sends "bytes: x-y/z", contrary to the
883          HTTP spec. */
884       if (*hdr == ':')
885         ++hdr;
886       while (c_isspace (*hdr))
887         ++hdr;
888       if (!*hdr)
889         return false;
890     }
891   if (!c_isdigit (*hdr))
892     return false;
893   for (num = 0; c_isdigit (*hdr); hdr++)
894     num = 10 * num + (*hdr - '0');
895   if (*hdr != '-' || !c_isdigit (*(hdr + 1)))
896     return false;
897   *first_byte_ptr = num;
898   ++hdr;
899   for (num = 0; c_isdigit (*hdr); hdr++)
900     num = 10 * num + (*hdr - '0');
901   if (*hdr != '/' || !c_isdigit (*(hdr + 1)))
902     return false;
903   *last_byte_ptr = num;
904   ++hdr;
905   if (*hdr == '*')
906     num = -1;
907   else
908     for (num = 0; c_isdigit (*hdr); hdr++)
909       num = 10 * num + (*hdr - '0');
910   *entity_length_ptr = num;
911   return true;
912 }
913
914 /* Read the body of the request, but don't store it anywhere and don't
915    display a progress gauge.  This is useful for reading the bodies of
916    administrative responses to which we will soon issue another
917    request.  The response is not useful to the user, but reading it
918    allows us to continue using the same connection to the server.
919
920    If reading fails, false is returned, true otherwise.  In debug
921    mode, the body is displayed for debugging purposes.  */
922
923 static bool
924 skip_short_body (int fd, wgint contlen, bool chunked)
925 {
926   enum {
927     SKIP_SIZE = 512,                /* size of the download buffer */
928     SKIP_THRESHOLD = 4096        /* the largest size we read */
929   };
930   wgint remaining_chunk_size = 0;
931   char dlbuf[SKIP_SIZE + 1];
932   dlbuf[SKIP_SIZE] = '\0';        /* so DEBUGP can safely print it */
933
934   assert (contlen != -1 || contlen);
935
936   /* If the body is too large, it makes more sense to simply close the
937      connection than to try to read the body.  */
938   if (contlen > SKIP_THRESHOLD)
939     return false;
940
941   while (contlen > 0 || chunked)
942     {
943       int ret;
944       if (chunked)
945         {
946           if (remaining_chunk_size == 0)
947             {
948               char *line = fd_read_line (fd);
949               char *endl;
950               if (line == NULL)
951                 break;
952
953               remaining_chunk_size = strtol (line, &endl, 16);
954               xfree (line);
955
956               if (remaining_chunk_size == 0)
957                 {
958                   line = fd_read_line (fd);
959                   xfree_null (line);
960                   break;
961                 }
962             }
963
964           contlen = MIN (remaining_chunk_size, SKIP_SIZE);
965         }
966
967       DEBUGP (("Skipping %s bytes of body: [", number_to_static_string (contlen)));
968
969       ret = fd_read (fd, dlbuf, MIN (contlen, SKIP_SIZE), -1);
970       if (ret <= 0)
971         {
972           /* Don't normally report the error since this is an
973              optimization that should be invisible to the user.  */
974           DEBUGP (("] aborting (%s).\n",
975                    ret < 0 ? fd_errstr (fd) : "EOF received"));
976           return false;
977         }
978       contlen -= ret;
979
980       if (chunked)
981         {
982           remaining_chunk_size -= ret;
983           if (remaining_chunk_size == 0)
984             {
985               char *line = fd_read_line (fd);
986               if (line == NULL)
987                 return false;
988               else
989                 xfree (line);
990             }
991         }
992
993       /* Safe even if %.*s bogusly expects terminating \0 because
994          we've zero-terminated dlbuf above.  */
995       DEBUGP (("%.*s", ret, dlbuf));
996     }
997
998   DEBUGP (("] done.\n"));
999   return true;
1000 }
1001
1002 #define NOT_RFC2231 0
1003 #define RFC2231_NOENCODING 1
1004 #define RFC2231_ENCODING 2
1005
1006 /* extract_param extracts the parameter name into NAME.
1007    However, if the parameter name is in RFC2231 format then
1008    this function adjusts NAME by stripping of the trailing
1009    characters that are not part of the name but are present to
1010    indicate the presence of encoding information in the value
1011    or a fragment of a long parameter value
1012 */
1013 static int
1014 modify_param_name(param_token *name)
1015 {
1016   const char *delim1 = memchr (name->b, '*', name->e - name->b);
1017   const char *delim2 = memrchr (name->b, '*', name->e - name->b);
1018
1019   int result;
1020
1021   if(delim1 == NULL)
1022     {
1023       result = NOT_RFC2231;
1024     }
1025   else if(delim1 == delim2)
1026     {
1027       if ((name->e - 1) == delim1)
1028         {
1029           result = RFC2231_ENCODING;
1030         }
1031       else
1032         {
1033           result = RFC2231_NOENCODING;
1034         }
1035       name->e = delim1;
1036     }
1037   else
1038     {
1039       name->e = delim1;
1040       result = RFC2231_ENCODING;
1041     }
1042   return result;
1043 }
1044
1045 /* extract_param extract the paramater value into VALUE.
1046    Like modify_param_name this function modifies VALUE by
1047    stripping off the encoding information from the actual value
1048 */
1049 static void
1050 modify_param_value (param_token *value, int encoding_type )
1051 {
1052   if (RFC2231_ENCODING == encoding_type)
1053     {
1054       const char *delim = memrchr (value->b, '\'', value->e - value->b);
1055       if ( delim != NULL )
1056         {
1057           value->b = (delim+1);
1058         }
1059     }
1060 }
1061
1062 /* Extract a parameter from the string (typically an HTTP header) at
1063    **SOURCE and advance SOURCE to the next parameter.  Return false
1064    when there are no more parameters to extract.  The name of the
1065    parameter is returned in NAME, and the value in VALUE.  If the
1066    parameter has no value, the token's value is zeroed out.
1067
1068    For example, if *SOURCE points to the string "attachment;
1069    filename=\"foo bar\"", the first call to this function will return
1070    the token named "attachment" and no value, and the second call will
1071    return the token named "filename" and value "foo bar".  The third
1072    call will return false, indicating no more valid tokens.  */
1073
1074 bool
1075 extract_param (const char **source, param_token *name, param_token *value,
1076                char separator)
1077 {
1078   const char *p = *source;
1079
1080   while (c_isspace (*p)) ++p;
1081   if (!*p)
1082     {
1083       *source = p;
1084       return false;             /* no error; nothing more to extract */
1085     }
1086
1087   /* Extract name. */
1088   name->b = p;
1089   while (*p && !c_isspace (*p) && *p != '=' && *p != separator) ++p;
1090   name->e = p;
1091   if (name->b == name->e)
1092     return false;               /* empty name: error */
1093   while (c_isspace (*p)) ++p;
1094   if (*p == separator || !*p)           /* no value */
1095     {
1096       xzero (*value);
1097       if (*p == separator) ++p;
1098       *source = p;
1099       return true;
1100     }
1101   if (*p != '=')
1102     return false;               /* error */
1103
1104   /* *p is '=', extract value */
1105   ++p;
1106   while (c_isspace (*p)) ++p;
1107   if (*p == '"')                /* quoted */
1108     {
1109       value->b = ++p;
1110       while (*p && *p != '"') ++p;
1111       if (!*p)
1112         return false;
1113       value->e = p++;
1114       /* Currently at closing quote; find the end of param. */
1115       while (c_isspace (*p)) ++p;
1116       while (*p && *p != separator) ++p;
1117       if (*p == separator)
1118         ++p;
1119       else if (*p)
1120         /* garbage after closed quote, e.g. foo="bar"baz */
1121         return false;
1122     }
1123   else                          /* unquoted */
1124     {
1125       value->b = p;
1126       while (*p && *p != separator) ++p;
1127       value->e = p;
1128       while (value->e != value->b && c_isspace (value->e[-1]))
1129         --value->e;
1130       if (*p == separator) ++p;
1131     }
1132   *source = p;
1133
1134   int param_type = modify_param_name(name);
1135   if (NOT_RFC2231 != param_type)
1136     {
1137       modify_param_value(value, param_type);
1138     }
1139   return true;
1140 }
1141
1142 #undef NOT_RFC2231
1143 #undef RFC2231_NOENCODING
1144 #undef RFC2231_ENCODING
1145
1146 /* Appends the string represented by VALUE to FILENAME */
1147
1148 static void
1149 append_value_to_filename (char **filename, param_token const * const value)
1150 {
1151   int original_length = strlen(*filename);
1152   int new_length = strlen(*filename) + (value->e - value->b);
1153   *filename = xrealloc (*filename, new_length+1);
1154   memcpy (*filename + original_length, value->b, (value->e - value->b)); 
1155   (*filename)[new_length] = '\0';
1156 }
1157
1158 #undef MAX
1159 #define MAX(p, q) ((p) > (q) ? (p) : (q))
1160
1161 /* Parse the contents of the `Content-Disposition' header, extracting
1162    the information useful to Wget.  Content-Disposition is a header
1163    borrowed from MIME; when used in HTTP, it typically serves for
1164    specifying the desired file name of the resource.  For example:
1165
1166        Content-Disposition: attachment; filename="flora.jpg"
1167
1168    Wget will skip the tokens it doesn't care about, such as
1169    "attachment" in the previous example; it will also skip other
1170    unrecognized params.  If the header is syntactically correct and
1171    contains a file name, a copy of the file name is stored in
1172    *filename and true is returned.  Otherwise, the function returns
1173    false.
1174
1175    The file name is stripped of directory components and must not be
1176    empty.
1177
1178    Historically, this function returned filename prefixed with opt.dir_prefix,
1179    now that logic is handled by the caller, new code should pay attention,
1180    changed by crq, Sep 2010.
1181
1182 */
1183 static bool
1184 parse_content_disposition (const char *hdr, char **filename)
1185 {
1186   param_token name, value;
1187   *filename = NULL;
1188   while (extract_param (&hdr, &name, &value, ';'))
1189     {
1190       int isFilename = BOUNDED_EQUAL_NO_CASE ( name.b, name.e, "filename" );
1191       if ( isFilename && value.b != NULL)
1192         {
1193           /* Make the file name begin at the last slash or backslash. */
1194           const char *last_slash = memrchr (value.b, '/', value.e - value.b);
1195           const char *last_bs = memrchr (value.b, '\\', value.e - value.b);
1196           if (last_slash && last_bs)
1197             value.b = 1 + MAX (last_slash, last_bs);
1198           else if (last_slash || last_bs)
1199             value.b = 1 + (last_slash ? last_slash : last_bs);
1200           if (value.b == value.e)
1201             continue;
1202
1203           if (*filename)
1204             append_value_to_filename (filename, &value);
1205           else
1206             *filename = strdupdelim (value.b, value.e);
1207         }
1208     }
1209
1210   if (*filename)
1211     return true;
1212   else
1213     return false;
1214 }
1215
1216 \f
1217 /* Persistent connections.  Currently, we cache the most recently used
1218    connection as persistent, provided that the HTTP server agrees to
1219    make it such.  The persistence data is stored in the variables
1220    below.  Ideally, it should be possible to cache an arbitrary fixed
1221    number of these connections.  */
1222
1223 /* Whether a persistent connection is active. */
1224 static bool pconn_active;
1225
1226 static struct {
1227   /* The socket of the connection.  */
1228   int socket;
1229
1230   /* Host and port of the currently active persistent connection. */
1231   char *host;
1232   int port;
1233
1234   /* Whether a ssl handshake has occoured on this connection.  */
1235   bool ssl;
1236
1237   /* Whether the connection was authorized.  This is only done by
1238      NTLM, which authorizes *connections* rather than individual
1239      requests.  (That practice is peculiar for HTTP, but it is a
1240      useful optimization.)  */
1241   bool authorized;
1242
1243 #ifdef ENABLE_NTLM
1244   /* NTLM data of the current connection.  */
1245   struct ntlmdata ntlm;
1246 #endif
1247 } pconn;
1248
1249 /* Mark the persistent connection as invalid and free the resources it
1250    uses.  This is used by the CLOSE_* macros after they forcefully
1251    close a registered persistent connection.  */
1252
1253 static void
1254 invalidate_persistent (void)
1255 {
1256   DEBUGP (("Disabling further reuse of socket %d.\n", pconn.socket));
1257   pconn_active = false;
1258   fd_close (pconn.socket);
1259   xfree (pconn.host);
1260   xzero (pconn);
1261 }
1262
1263 /* Register FD, which should be a TCP/IP connection to HOST:PORT, as
1264    persistent.  This will enable someone to use the same connection
1265    later.  In the context of HTTP, this must be called only AFTER the
1266    response has been received and the server has promised that the
1267    connection will remain alive.
1268
1269    If a previous connection was persistent, it is closed. */
1270
1271 static void
1272 register_persistent (const char *host, int port, int fd, bool ssl)
1273 {
1274   if (pconn_active)
1275     {
1276       if (pconn.socket == fd)
1277         {
1278           /* The connection FD is already registered. */
1279           return;
1280         }
1281       else
1282         {
1283           /* The old persistent connection is still active; close it
1284              first.  This situation arises whenever a persistent
1285              connection exists, but we then connect to a different
1286              host, and try to register a persistent connection to that
1287              one.  */
1288           invalidate_persistent ();
1289         }
1290     }
1291
1292   pconn_active = true;
1293   pconn.socket = fd;
1294   pconn.host = xstrdup (host);
1295   pconn.port = port;
1296   pconn.ssl = ssl;
1297   pconn.authorized = false;
1298
1299   DEBUGP (("Registered socket %d for persistent reuse.\n", fd));
1300 }
1301
1302 /* Return true if a persistent connection is available for connecting
1303    to HOST:PORT.  */
1304
1305 static bool
1306 persistent_available_p (const char *host, int port, bool ssl,
1307                         bool *host_lookup_failed)
1308 {
1309   /* First, check whether a persistent connection is active at all.  */
1310   if (!pconn_active)
1311     return false;
1312
1313   /* If we want SSL and the last connection wasn't or vice versa,
1314      don't use it.  Checking for host and port is not enough because
1315      HTTP and HTTPS can apparently coexist on the same port.  */
1316   if (ssl != pconn.ssl)
1317     return false;
1318
1319   /* If we're not connecting to the same port, we're not interested. */
1320   if (port != pconn.port)
1321     return false;
1322
1323   /* If the host is the same, we're in business.  If not, there is
1324      still hope -- read below.  */
1325   if (0 != strcasecmp (host, pconn.host))
1326     {
1327       /* Check if pconn.socket is talking to HOST under another name.
1328          This happens often when both sites are virtual hosts
1329          distinguished only by name and served by the same network
1330          interface, and hence the same web server (possibly set up by
1331          the ISP and serving many different web sites).  This
1332          admittedly unconventional optimization does not contradict
1333          HTTP and works well with popular server software.  */
1334
1335       bool found;
1336       ip_address ip;
1337       struct address_list *al;
1338
1339       if (ssl)
1340         /* Don't try to talk to two different SSL sites over the same
1341            secure connection!  (Besides, it's not clear that
1342            name-based virtual hosting is even possible with SSL.)  */
1343         return false;
1344
1345       /* If pconn.socket's peer is one of the IP addresses HOST
1346          resolves to, pconn.socket is for all intents and purposes
1347          already talking to HOST.  */
1348
1349       if (!socket_ip_address (pconn.socket, &ip, ENDPOINT_PEER))
1350         {
1351           /* Can't get the peer's address -- something must be very
1352              wrong with the connection.  */
1353           invalidate_persistent ();
1354           return false;
1355         }
1356       al = lookup_host (host, 0);
1357       if (!al)
1358         {
1359           *host_lookup_failed = true;
1360           return false;
1361         }
1362
1363       found = address_list_contains (al, &ip);
1364       address_list_release (al);
1365
1366       if (!found)
1367         return false;
1368
1369       /* The persistent connection's peer address was found among the
1370          addresses HOST resolved to; therefore, pconn.sock is in fact
1371          already talking to HOST -- no need to reconnect.  */
1372     }
1373
1374   /* Finally, check whether the connection is still open.  This is
1375      important because most servers implement liberal (short) timeout
1376      on persistent connections.  Wget can of course always reconnect
1377      if the connection doesn't work out, but it's nicer to know in
1378      advance.  This test is a logical followup of the first test, but
1379      is "expensive" and therefore placed at the end of the list.
1380
1381      (Current implementation of test_socket_open has a nice side
1382      effect that it treats sockets with pending data as "closed".
1383      This is exactly what we want: if a broken server sends message
1384      body in response to HEAD, or if it sends more than conent-length
1385      data, we won't reuse the corrupted connection.)  */
1386
1387   if (!test_socket_open (pconn.socket))
1388     {
1389       /* Oops, the socket is no longer open.  Now that we know that,
1390          let's invalidate the persistent connection before returning
1391          0.  */
1392       invalidate_persistent ();
1393       return false;
1394     }
1395
1396   return true;
1397 }
1398
1399 /* The idea behind these two CLOSE macros is to distinguish between
1400    two cases: one when the job we've been doing is finished, and we
1401    want to close the connection and leave, and two when something is
1402    seriously wrong and we're closing the connection as part of
1403    cleanup.
1404
1405    In case of keep_alive, CLOSE_FINISH should leave the connection
1406    open, while CLOSE_INVALIDATE should still close it.
1407
1408    Note that the semantics of the flag `keep_alive' is "this
1409    connection *will* be reused (the server has promised not to close
1410    the connection once we're done)", while the semantics of
1411    `pc_active_p && (fd) == pc_last_fd' is "we're *now* using an
1412    active, registered connection".  */
1413
1414 #define CLOSE_FINISH(fd) do {                   \
1415   if (!keep_alive)                              \
1416     {                                           \
1417       if (pconn_active && (fd) == pconn.socket) \
1418         invalidate_persistent ();               \
1419       else                                      \
1420         {                                       \
1421           fd_close (fd);                        \
1422           fd = -1;                              \
1423         }                                       \
1424     }                                           \
1425 } while (0)
1426
1427 #define CLOSE_INVALIDATE(fd) do {               \
1428   if (pconn_active && (fd) == pconn.socket)     \
1429     invalidate_persistent ();                   \
1430   else                                          \
1431     fd_close (fd);                              \
1432   fd = -1;                                      \
1433 } while (0)
1434 \f
1435 struct http_stat
1436 {
1437   wgint len;                    /* received length */
1438   wgint contlen;                /* expected length */
1439   wgint restval;                /* the restart value */
1440   int res;                      /* the result of last read */
1441   char *rderrmsg;               /* error message from read error */
1442   char *newloc;                 /* new location (redirection) */
1443   char *remote_time;            /* remote time-stamp string */
1444   char *error;                  /* textual HTTP error */
1445   int statcode;                 /* status code */
1446   char *message;                /* status message */
1447   wgint rd_size;                /* amount of data read from socket */
1448   double dltime;                /* time it took to download the data */
1449   const char *referer;          /* value of the referer header. */
1450   char *local_file;             /* local file name. */
1451   bool existence_checked;       /* true if we already checked for a file's
1452                                    existence after having begun to download
1453                                    (needed in gethttp for when connection is
1454                                    interrupted/restarted. */
1455   bool timestamp_checked;       /* true if pre-download time-stamping checks
1456                                  * have already been performed */
1457   char *orig_file_name;         /* name of file to compare for time-stamping
1458                                  * (might be != local_file if -K is set) */
1459   wgint orig_file_size;         /* size of file to compare for time-stamping */
1460   time_t orig_file_tstamp;      /* time-stamp of file to compare for
1461                                  * time-stamping */
1462 };
1463
1464 static void
1465 free_hstat (struct http_stat *hs)
1466 {
1467   xfree_null (hs->newloc);
1468   xfree_null (hs->remote_time);
1469   xfree_null (hs->error);
1470   xfree_null (hs->rderrmsg);
1471   xfree_null (hs->local_file);
1472   xfree_null (hs->orig_file_name);
1473   xfree_null (hs->message);
1474
1475   /* Guard against being called twice. */
1476   hs->newloc = NULL;
1477   hs->remote_time = NULL;
1478   hs->error = NULL;
1479 }
1480
1481 static void
1482 get_file_flags (const char *filename, int *dt)
1483 {
1484   logprintf (LOG_VERBOSE, _("\
1485 File %s already there; not retrieving.\n\n"), quote (filename));
1486   /* If the file is there, we suppose it's retrieved OK.  */
1487   *dt |= RETROKF;
1488
1489   /* #### Bogusness alert.  */
1490   /* If its suffix is "html" or "htm" or similar, assume text/html.  */
1491   if (has_html_suffix_p (filename))
1492     *dt |= TEXTHTML;
1493 }
1494
1495 /* Download the response body from the socket and writes it to
1496    an output file.  The headers have already been read from the
1497    socket.  If WARC is enabled, the response body will also be
1498    written to a WARC response record.
1499
1500    hs, contlen, contrange, chunked_transfer_encoding and url are
1501    parameters from the gethttp method.  fp is a pointer to the
1502    output file.
1503
1504    url, warc_timestamp_str, warc_request_uuid, warc_ip, type
1505    and statcode will be saved in the headers of the WARC record.
1506    The head parameter contains the HTTP headers of the response.
1507  
1508    If fp is NULL and WARC is enabled, the response body will be
1509    written only to the WARC file.  If WARC is disabled and fp
1510    is a file pointer, the data will be written to the file.
1511    If fp is a file pointer and WARC is enabled, the body will
1512    be written to both destinations.
1513    
1514    Returns the error code.   */
1515 static int
1516 read_response_body (struct http_stat *hs, int sock, FILE *fp, wgint contlen,
1517                     wgint contrange, bool chunked_transfer_encoding,
1518                     char *url, char *warc_timestamp_str, char *warc_request_uuid,
1519                     ip_address *warc_ip, char *type, int statcode, char *head)
1520 {
1521   int warc_payload_offset = 0;
1522   FILE *warc_tmp = NULL;
1523   int warcerr = 0;
1524
1525   if (opt.warc_filename != NULL)
1526     {
1527       /* Open a temporary file where we can write the response before we
1528          add it to the WARC record.  */
1529       warc_tmp = warc_tempfile ();
1530       if (warc_tmp == NULL)
1531         warcerr = WARC_TMP_FOPENERR;
1532
1533       if (warcerr == 0)
1534         {
1535           /* We should keep the response headers for the WARC record.  */
1536           int head_len = strlen (head);
1537           int warc_tmp_written = fwrite (head, 1, head_len, warc_tmp);
1538           if (warc_tmp_written != head_len)
1539             warcerr = WARC_TMP_FWRITEERR;
1540           warc_payload_offset = head_len;
1541         }
1542
1543       if (warcerr != 0)
1544         {
1545           if (warc_tmp != NULL)
1546             fclose (warc_tmp);
1547           return warcerr;
1548         }
1549     }
1550
1551   if (fp != NULL)
1552     {
1553       /* This confuses the timestamping code that checks for file size.
1554          #### The timestamping code should be smarter about file size.  */
1555       if (opt.save_headers && hs->restval == 0)
1556         fwrite (head, 1, strlen (head), fp);
1557     }
1558
1559   /* Read the response body.  */
1560   int flags = 0;
1561   if (contlen != -1)
1562     /* If content-length is present, read that much; otherwise, read
1563        until EOF.  The HTTP spec doesn't require the server to
1564        actually close the connection when it's done sending data. */
1565     flags |= rb_read_exactly;
1566   if (fp != NULL && hs->restval > 0 && contrange == 0)
1567     /* If the server ignored our range request, instruct fd_read_body
1568        to skip the first RESTVAL bytes of body.  */
1569     flags |= rb_skip_startpos;
1570   if (chunked_transfer_encoding)
1571     flags |= rb_chunked_transfer_encoding;
1572
1573   hs->len = hs->restval;
1574   hs->rd_size = 0;
1575   /* Download the response body and write it to fp.
1576      If we are working on a WARC file, we simultaneously write the
1577      response body to warc_tmp.  */
1578   hs->res = fd_read_body (sock, fp, contlen != -1 ? contlen : 0,
1579                           hs->restval, &hs->rd_size, &hs->len, &hs->dltime,
1580                           flags, warc_tmp);
1581   if (hs->res >= 0)
1582     {
1583       if (warc_tmp != NULL)
1584         {
1585           /* Create a response record and write it to the WARC file.
1586              Note: per the WARC standard, the request and response should share
1587              the same date header.  We re-use the timestamp of the request.
1588              The response record should also refer to the uuid of the request.  */
1589           bool r = warc_write_response_record (url, warc_timestamp_str,
1590                                                warc_request_uuid, warc_ip,
1591                                                warc_tmp, warc_payload_offset,
1592                                                type, statcode, hs->newloc);
1593
1594           /* warc_write_response_record has closed warc_tmp. */
1595
1596           if (! r)
1597             return WARC_ERR;
1598         }
1599
1600       return RETRFINISHED;
1601     }
1602   
1603   if (warc_tmp != NULL)
1604     fclose (warc_tmp);
1605
1606   if (hs->res == -2)
1607     {
1608       /* Error while writing to fd. */
1609       return FWRITEERR;
1610     }
1611   else if (hs->res == -3)
1612     {
1613       /* Error while writing to warc_tmp. */
1614       return WARC_TMP_FWRITEERR;
1615     }
1616   else
1617     {
1618       /* A read error! */
1619       hs->rderrmsg = xstrdup (fd_errstr (sock));
1620       return RETRFINISHED;
1621     }
1622 }
1623
1624 #define BEGINS_WITH(line, string_constant)                               \
1625   (!strncasecmp (line, string_constant, sizeof (string_constant) - 1)    \
1626    && (c_isspace (line[sizeof (string_constant) - 1])                      \
1627        || !line[sizeof (string_constant) - 1]))
1628
1629 #ifdef __VMS
1630 #define SET_USER_AGENT(req) do {                                         \
1631   if (!opt.useragent)                                                    \
1632     request_set_header (req, "User-Agent",                               \
1633                         aprintf ("Wget/%s (VMS %s %s)",                  \
1634                         version_string, vms_arch(), vms_vers()),         \
1635                         rel_value);                                      \
1636   else if (*opt.useragent)                                               \
1637     request_set_header (req, "User-Agent", opt.useragent, rel_none);     \
1638 } while (0)
1639 #else /* def __VMS */
1640 #define SET_USER_AGENT(req) do {                                         \
1641   if (!opt.useragent)                                                    \
1642     request_set_header (req, "User-Agent",                               \
1643                         aprintf ("Wget/%s (%s)",                         \
1644                         version_string, OS_TYPE),                        \
1645                         rel_value);                                      \
1646   else if (*opt.useragent)                                               \
1647     request_set_header (req, "User-Agent", opt.useragent, rel_none);     \
1648 } while (0)
1649 #endif /* def __VMS [else] */
1650
1651 /* The flags that allow clobbering the file (opening with "wb").
1652    Defined here to avoid repetition later.  #### This will require
1653    rework.  */
1654 #define ALLOW_CLOBBER (opt.noclobber || opt.always_rest || opt.timestamping \
1655                        || opt.dirstruct || opt.output_document)
1656
1657 /* Retrieve a document through HTTP protocol.  It recognizes status
1658    code, and correctly handles redirections.  It closes the network
1659    socket.  If it receives an error from the functions below it, it
1660    will print it if there is enough information to do so (almost
1661    always), returning the error to the caller (i.e. http_loop).
1662
1663    Various HTTP parameters are stored to hs.
1664
1665    If PROXY is non-NULL, the connection will be made to the proxy
1666    server, and u->url will be requested.  */
1667 static uerr_t
1668 gethttp (struct url *u, struct http_stat *hs, int *dt, struct url *proxy,
1669          struct iri *iri, int count)
1670 {
1671   struct request *req;
1672
1673   char *type;
1674   char *user, *passwd;
1675   char *proxyauth;
1676   int statcode;
1677   int write_error;
1678   wgint contlen, contrange;
1679   struct url *conn;
1680   FILE *fp;
1681   int err;
1682
1683   int sock = -1;
1684
1685   /* Set to 1 when the authorization has already been sent and should
1686      not be tried again. */
1687   bool auth_finished = false;
1688
1689   /* Set to 1 when just globally-set Basic authorization has been sent;
1690    * should prevent further Basic negotiations, but not other
1691    * mechanisms. */
1692   bool basic_auth_finished = false;
1693
1694   /* Whether NTLM authentication is used for this request. */
1695   bool ntlm_seen = false;
1696
1697   /* Whether our connection to the remote host is through SSL.  */
1698   bool using_ssl = false;
1699
1700   /* Whether a HEAD request will be issued (as opposed to GET or
1701      POST). */
1702   bool head_only = !!(*dt & HEAD_ONLY);
1703
1704   char *head;
1705   struct response *resp;
1706   char hdrval[256];
1707   char *message;
1708
1709   /* Declare WARC variables. */
1710   bool warc_enabled = (opt.warc_filename != NULL);
1711   FILE *warc_tmp = NULL;
1712   char warc_timestamp_str [21];
1713   char warc_request_uuid [48];
1714   ip_address *warc_ip = NULL;
1715   off_t warc_payload_offset = -1;
1716
1717   /* Whether this connection will be kept alive after the HTTP request
1718      is done. */
1719   bool keep_alive;
1720
1721   /* Is the server using the chunked transfer encoding?  */
1722   bool chunked_transfer_encoding = false;
1723
1724   /* Whether keep-alive should be inhibited.  */
1725   bool inhibit_keep_alive =
1726     !opt.http_keep_alive || opt.ignore_length;
1727
1728   /* Headers sent when using POST. */
1729   wgint body_data_size = 0;
1730
1731   bool host_lookup_failed = false;
1732
1733 #ifdef HAVE_SSL
1734   if (u->scheme == SCHEME_HTTPS)
1735     {
1736       /* Initialize the SSL context.  After this has once been done,
1737          it becomes a no-op.  */
1738       if (!ssl_init ())
1739         {
1740           scheme_disable (SCHEME_HTTPS);
1741           logprintf (LOG_NOTQUIET,
1742                      _("Disabling SSL due to encountered errors.\n"));
1743           return SSLINITFAILED;
1744         }
1745     }
1746 #endif /* HAVE_SSL */
1747
1748   /* Initialize certain elements of struct http_stat.  */
1749   hs->len = 0;
1750   hs->contlen = -1;
1751   hs->res = -1;
1752   hs->rderrmsg = NULL;
1753   hs->newloc = NULL;
1754   hs->remote_time = NULL;
1755   hs->error = NULL;
1756   hs->message = NULL;
1757
1758   conn = u;
1759
1760   /* Prepare the request to send. */
1761
1762   req = request_new ();
1763   {
1764     char *meth_arg;
1765     const char *meth = "GET";
1766     if (head_only)
1767       meth = "HEAD";
1768     else if (opt.method)
1769       meth = opt.method;
1770     /* Use the full path, i.e. one that includes the leading slash and
1771        the query string.  E.g. if u->path is "foo/bar" and u->query is
1772        "param=value", full_path will be "/foo/bar?param=value".  */
1773     if (proxy
1774 #ifdef HAVE_SSL
1775         /* When using SSL over proxy, CONNECT establishes a direct
1776            connection to the HTTPS server.  Therefore use the same
1777            argument as when talking to the server directly. */
1778         && u->scheme != SCHEME_HTTPS
1779 #endif
1780         )
1781       meth_arg = xstrdup (u->url);
1782     else
1783       meth_arg = url_full_path (u);
1784     request_set_method (req, meth, meth_arg);
1785   }
1786
1787   request_set_header (req, "Referer", (char *) hs->referer, rel_none);
1788   if (*dt & SEND_NOCACHE)
1789     {
1790       /* Cache-Control MUST be obeyed by all HTTP/1.1 caching mechanisms...  */
1791       request_set_header (req, "Cache-Control", "no-cache, must-revalidate", rel_none);
1792
1793       /* ... but some HTTP/1.0 caches doesn't implement Cache-Control.  */
1794       request_set_header (req, "Pragma", "no-cache", rel_none);
1795     }
1796   if (hs->restval)
1797     request_set_header (req, "Range",
1798                         aprintf ("bytes=%s-",
1799                                  number_to_static_string (hs->restval)),
1800                         rel_value);
1801   SET_USER_AGENT (req);
1802   request_set_header (req, "Accept", "*/*", rel_none);
1803
1804   /* Find the username and password for authentication. */
1805   user = u->user;
1806   passwd = u->passwd;
1807   search_netrc (u->host, (const char **)&user, (const char **)&passwd, 0);
1808   user = user ? user : (opt.http_user ? opt.http_user : opt.user);
1809   passwd = passwd ? passwd : (opt.http_passwd ? opt.http_passwd : opt.passwd);
1810
1811   /* We only do "site-wide" authentication with "global" user/password
1812    * values unless --auth-no-challange has been requested; URL user/password
1813    * info overrides. */
1814   if (user && passwd && (!u->user || opt.auth_without_challenge))
1815     {
1816       /* If this is a host for which we've already received a Basic
1817        * challenge, we'll go ahead and send Basic authentication creds. */
1818       basic_auth_finished = maybe_send_basic_creds(u->host, user, passwd, req);
1819     }
1820
1821   /* Generate the Host header, HOST:PORT.  Take into account that:
1822
1823      - Broken server-side software often doesn't recognize the PORT
1824        argument, so we must generate "Host: www.server.com" instead of
1825        "Host: www.server.com:80" (and likewise for https port).
1826
1827      - IPv6 addresses contain ":", so "Host: 3ffe:8100:200:2::2:1234"
1828        becomes ambiguous and needs to be rewritten as "Host:
1829        [3ffe:8100:200:2::2]:1234".  */
1830   {
1831     /* Formats arranged for hfmt[add_port][add_squares].  */
1832     static const char *hfmt[][2] = {
1833       { "%s", "[%s]" }, { "%s:%d", "[%s]:%d" }
1834     };
1835     int add_port = u->port != scheme_default_port (u->scheme);
1836     int add_squares = strchr (u->host, ':') != NULL;
1837     request_set_header (req, "Host",
1838                         aprintf (hfmt[add_port][add_squares], u->host, u->port),
1839                         rel_value);
1840   }
1841
1842   if (inhibit_keep_alive)
1843     request_set_header (req, "Connection", "Close", rel_none);
1844   else
1845     {
1846       if (proxy == NULL)
1847         request_set_header (req, "Connection", "Keep-Alive", rel_none);
1848       else
1849         {
1850           request_set_header (req, "Connection", "Close", rel_none);
1851           request_set_header (req, "Proxy-Connection", "Keep-Alive", rel_none);
1852         }
1853     }
1854
1855   if (opt.method)
1856     {
1857
1858       if (opt.body_data || opt.body_file)
1859         {
1860           request_set_header (req, "Content-Type",
1861                               "application/x-www-form-urlencoded", rel_none);
1862
1863           if (opt.body_data)
1864             body_data_size = strlen (opt.body_data);
1865           else
1866             {
1867               body_data_size = file_size (opt.body_file);
1868               if (body_data_size == -1)
1869                 {
1870                   logprintf (LOG_NOTQUIET, _("BODY data file %s missing: %s\n"),
1871                              quote (opt.body_file), strerror (errno));
1872                   return FILEBADFILE;
1873                 }
1874             }
1875           request_set_header (req, "Content-Length",
1876                               xstrdup (number_to_static_string (body_data_size)),
1877                               rel_value);
1878         }
1879     }
1880
1881  retry_with_auth:
1882   /* We need to come back here when the initial attempt to retrieve
1883      without authorization header fails.  (Expected to happen at least
1884      for the Digest authorization scheme.)  */
1885
1886   if (opt.cookies)
1887     request_set_header (req, "Cookie",
1888                         cookie_header (wget_cookie_jar,
1889                                        u->host, u->port, u->path,
1890 #ifdef HAVE_SSL
1891                                        u->scheme == SCHEME_HTTPS
1892 #else
1893                                        0
1894 #endif
1895                                        ),
1896                         rel_value);
1897
1898   /* Add the user headers. */
1899   if (opt.user_headers)
1900     {
1901       int i;
1902       for (i = 0; opt.user_headers[i]; i++)
1903         request_set_user_header (req, opt.user_headers[i]);
1904     }
1905
1906   proxyauth = NULL;
1907   if (proxy)
1908     {
1909       char *proxy_user, *proxy_passwd;
1910       /* For normal username and password, URL components override
1911          command-line/wgetrc parameters.  With proxy
1912          authentication, it's the reverse, because proxy URLs are
1913          normally the "permanent" ones, so command-line args
1914          should take precedence.  */
1915       if (opt.proxy_user && opt.proxy_passwd)
1916         {
1917           proxy_user = opt.proxy_user;
1918           proxy_passwd = opt.proxy_passwd;
1919         }
1920       else
1921         {
1922           proxy_user = proxy->user;
1923           proxy_passwd = proxy->passwd;
1924         }
1925       /* #### This does not appear right.  Can't the proxy request,
1926          say, `Digest' authentication?  */
1927       if (proxy_user && proxy_passwd)
1928         proxyauth = basic_authentication_encode (proxy_user, proxy_passwd);
1929
1930       /* If we're using a proxy, we will be connecting to the proxy
1931          server.  */
1932       conn = proxy;
1933
1934       /* Proxy authorization over SSL is handled below. */
1935 #ifdef HAVE_SSL
1936       if (u->scheme != SCHEME_HTTPS)
1937 #endif
1938         request_set_header (req, "Proxy-Authorization", proxyauth, rel_value);
1939     }
1940
1941   keep_alive = true;
1942
1943   /* Establish the connection.  */
1944
1945   if (inhibit_keep_alive)
1946     keep_alive = false;
1947   else
1948     {
1949       /* Look for a persistent connection to target host, unless a
1950          proxy is used.  The exception is when SSL is in use, in which
1951          case the proxy is nothing but a passthrough to the target
1952          host, registered as a connection to the latter.  */
1953       struct url *relevant = conn;
1954 #ifdef HAVE_SSL
1955       if (u->scheme == SCHEME_HTTPS)
1956         relevant = u;
1957 #endif
1958
1959       if (persistent_available_p (relevant->host, relevant->port,
1960 #ifdef HAVE_SSL
1961                                   relevant->scheme == SCHEME_HTTPS,
1962 #else
1963                                   0,
1964 #endif
1965                                   &host_lookup_failed))
1966         {
1967           int family = socket_family (pconn.socket, ENDPOINT_PEER);
1968           sock = pconn.socket;
1969           using_ssl = pconn.ssl;
1970 #if ENABLE_IPV6
1971           if (family == AF_INET6)
1972              logprintf (LOG_VERBOSE, _("Reusing existing connection to [%s]:%d.\n"),
1973                         quotearg_style (escape_quoting_style, pconn.host),
1974                          pconn.port);
1975           else
1976 #endif
1977              logprintf (LOG_VERBOSE, _("Reusing existing connection to %s:%d.\n"),
1978                         quotearg_style (escape_quoting_style, pconn.host),
1979                         pconn.port);
1980           DEBUGP (("Reusing fd %d.\n", sock));
1981           if (pconn.authorized)
1982             /* If the connection is already authorized, the "Basic"
1983                authorization added by code above is unnecessary and
1984                only hurts us.  */
1985             request_remove_header (req, "Authorization");
1986         }
1987       else if (host_lookup_failed)
1988         {
1989           request_free (req);
1990           logprintf(LOG_NOTQUIET,
1991                     _("%s: unable to resolve host address %s\n"),
1992                     exec_name, quote (relevant->host));
1993           return HOSTERR;
1994         }
1995     }
1996
1997   if (sock < 0)
1998     {
1999       sock = connect_to_host (conn->host, conn->port);
2000       if (sock == E_HOST)
2001         {
2002           request_free (req);
2003           return HOSTERR;
2004         }
2005       else if (sock < 0)
2006         {
2007           request_free (req);
2008           return (retryable_socket_connect_error (errno)
2009                   ? CONERROR : CONIMPOSSIBLE);
2010         }
2011
2012 #ifdef HAVE_SSL
2013       if (proxy && u->scheme == SCHEME_HTTPS)
2014         {
2015           /* When requesting SSL URLs through proxies, use the
2016              CONNECT method to request passthrough.  */
2017           struct request *connreq = request_new ();
2018           request_set_method (connreq, "CONNECT",
2019                               aprintf ("%s:%d", u->host, u->port));
2020           SET_USER_AGENT (connreq);
2021           if (proxyauth)
2022             {
2023               request_set_header (connreq, "Proxy-Authorization",
2024                                   proxyauth, rel_value);
2025               /* Now that PROXYAUTH is part of the CONNECT request,
2026                  zero it out so we don't send proxy authorization with
2027                  the regular request below.  */
2028               proxyauth = NULL;
2029             }
2030           /* Examples in rfc2817 use the Host header in CONNECT
2031              requests.  I don't see how that gains anything, given
2032              that the contents of Host would be exactly the same as
2033              the contents of CONNECT.  */
2034
2035           write_error = request_send (connreq, sock, 0);
2036           request_free (connreq);
2037           if (write_error < 0)
2038             {
2039               CLOSE_INVALIDATE (sock);
2040               request_free (req);
2041               return WRITEFAILED;
2042             }
2043
2044           head = read_http_response_head (sock);
2045           if (!head)
2046             {
2047               logprintf (LOG_VERBOSE, _("Failed reading proxy response: %s\n"),
2048                          fd_errstr (sock));
2049               CLOSE_INVALIDATE (sock);
2050               request_free (req);
2051               return HERR;
2052             }
2053           message = NULL;
2054           if (!*head)
2055             {
2056               xfree (head);
2057               goto failed_tunnel;
2058             }
2059           DEBUGP (("proxy responded with: [%s]\n", head));
2060
2061           resp = resp_new (head);
2062           statcode = resp_status (resp, &message);
2063           if (statcode < 0)
2064             {
2065               char *tms = datetime_str (time (NULL));
2066               logprintf (LOG_VERBOSE, "%d\n", statcode);
2067               logprintf (LOG_NOTQUIET, _("%s ERROR %d: %s.\n"), tms, statcode,
2068                          quotearg_style (escape_quoting_style,
2069                                          _("Malformed status line")));
2070               xfree (head);
2071               request_free (req);
2072               return HERR;
2073             }
2074           hs->message = xstrdup (message);
2075           resp_free (resp);
2076           xfree (head);
2077           if (statcode != 200)
2078             {
2079             failed_tunnel:
2080               logprintf (LOG_NOTQUIET, _("Proxy tunneling failed: %s"),
2081                          message ? quotearg_style (escape_quoting_style, message) : "?");
2082               xfree_null (message);
2083               request_free (req);
2084               return CONSSLERR;
2085             }
2086           xfree_null (message);
2087
2088           /* SOCK is now *really* connected to u->host, so update CONN
2089              to reflect this.  That way register_persistent will
2090              register SOCK as being connected to u->host:u->port.  */
2091           conn = u;
2092         }
2093
2094       if (conn->scheme == SCHEME_HTTPS)
2095         {
2096           if (!ssl_connect_wget (sock, u->host))
2097             {
2098               fd_close (sock);
2099               request_free (req);
2100               return CONSSLERR;
2101             }
2102           else if (!ssl_check_certificate (sock, u->host))
2103             {
2104               fd_close (sock);
2105               request_free (req);
2106               return VERIFCERTERR;
2107             }
2108           using_ssl = true;
2109         }
2110 #endif /* HAVE_SSL */
2111     }
2112
2113   /* Open the temporary file where we will write the request. */
2114   if (warc_enabled)
2115     {
2116       warc_tmp = warc_tempfile ();
2117       if (warc_tmp == NULL)
2118         {
2119           CLOSE_INVALIDATE (sock);
2120           request_free (req);
2121           return WARC_TMP_FOPENERR;
2122         }
2123
2124       if (! proxy)
2125         {
2126           warc_ip = (ip_address *) alloca (sizeof (ip_address));
2127           socket_ip_address (sock, warc_ip, ENDPOINT_PEER);
2128         }
2129     }
2130
2131   /* Send the request to server.  */
2132   write_error = request_send (req, sock, warc_tmp);
2133
2134   if (write_error >= 0)
2135     {
2136       if (opt.body_data)
2137         {
2138           DEBUGP (("[BODY data: %s]\n", opt.body_data));
2139           write_error = fd_write (sock, opt.body_data, body_data_size, -1);
2140           if (write_error >= 0 && warc_tmp != NULL)
2141             {
2142               /* Remember end of headers / start of payload. */
2143               warc_payload_offset = ftello (warc_tmp);
2144
2145               /* Write a copy of the data to the WARC record. */
2146               int warc_tmp_written = fwrite (opt.body_data, 1, body_data_size, warc_tmp);
2147               if (warc_tmp_written != body_data_size)
2148                 write_error = -2;
2149             }
2150          }
2151       else if (opt.body_file && body_data_size != 0)
2152         {
2153           if (warc_tmp != NULL)
2154             /* Remember end of headers / start of payload */
2155             warc_payload_offset = ftello (warc_tmp);
2156
2157           write_error = body_file_send (sock, opt.body_file, body_data_size, warc_tmp);
2158         }
2159     }
2160
2161   if (write_error < 0)
2162     {
2163       CLOSE_INVALIDATE (sock);
2164       request_free (req);
2165
2166       if (warc_tmp != NULL)
2167         fclose (warc_tmp);
2168
2169       if (write_error == -2)
2170         return WARC_TMP_FWRITEERR;
2171       else
2172         return WRITEFAILED;
2173     }
2174   logprintf (LOG_VERBOSE, _("%s request sent, awaiting response... "),
2175              proxy ? "Proxy" : "HTTP");
2176   contlen = -1;
2177   contrange = 0;
2178   *dt &= ~RETROKF;
2179
2180
2181   if (warc_enabled)
2182     {
2183       bool warc_result;
2184       /* Generate a timestamp and uuid for this request. */
2185       warc_timestamp (warc_timestamp_str);
2186       warc_uuid_str (warc_request_uuid);
2187
2188       /* Create a request record and store it in the WARC file. */
2189       warc_result = warc_write_request_record (u->url, warc_timestamp_str,
2190                                                warc_request_uuid, warc_ip,
2191                                                warc_tmp, warc_payload_offset);
2192       if (! warc_result)
2193         {
2194           CLOSE_INVALIDATE (sock);
2195           request_free (req);
2196           return WARC_ERR;
2197         }
2198
2199       /* warc_write_request_record has also closed warc_tmp. */
2200     }
2201
2202
2203 read_header:
2204   head = read_http_response_head (sock);
2205   if (!head)
2206     {
2207       if (errno == 0)
2208         {
2209           logputs (LOG_NOTQUIET, _("No data received.\n"));
2210           CLOSE_INVALIDATE (sock);
2211           request_free (req);
2212           return HEOF;
2213         }
2214       else
2215         {
2216           logprintf (LOG_NOTQUIET, _("Read error (%s) in headers.\n"),
2217                      fd_errstr (sock));
2218           CLOSE_INVALIDATE (sock);
2219           request_free (req);
2220           return HERR;
2221         }
2222     }
2223   DEBUGP (("\n---response begin---\n%s---response end---\n", head));
2224
2225   resp = resp_new (head);
2226
2227   /* Check for status line.  */
2228   message = NULL;
2229   statcode = resp_status (resp, &message);
2230   if (statcode < 0)
2231     {
2232       char *tms = datetime_str (time (NULL));
2233       logprintf (LOG_VERBOSE, "%d\n", statcode);
2234       logprintf (LOG_NOTQUIET, _("%s ERROR %d: %s.\n"), tms, statcode,
2235                  quotearg_style (escape_quoting_style,
2236                                  _("Malformed status line")));
2237       CLOSE_INVALIDATE (sock);
2238       resp_free (resp);
2239       request_free (req);
2240       xfree (head);
2241       return HERR;
2242     }
2243
2244   if (H_10X (statcode))
2245     {
2246       DEBUGP (("Ignoring response\n"));
2247       resp_free (resp);
2248       xfree (head);
2249       goto read_header;
2250     }
2251
2252   hs->message = xstrdup (message);
2253   if (!opt.server_response)
2254     logprintf (LOG_VERBOSE, "%2d %s\n", statcode,
2255                message ? quotearg_style (escape_quoting_style, message) : "");
2256   else
2257     {
2258       logprintf (LOG_VERBOSE, "\n");
2259       print_server_response (resp, "  ");
2260     }
2261
2262   if (!opt.ignore_length
2263       && resp_header_copy (resp, "Content-Length", hdrval, sizeof (hdrval)))
2264     {
2265       wgint parsed;
2266       errno = 0;
2267       parsed = str_to_wgint (hdrval, NULL, 10);
2268       if (parsed == WGINT_MAX && errno == ERANGE)
2269         {
2270           /* Out of range.
2271              #### If Content-Length is out of range, it most likely
2272              means that the file is larger than 2G and that we're
2273              compiled without LFS.  In that case we should probably
2274              refuse to even attempt to download the file.  */
2275           contlen = -1;
2276         }
2277       else if (parsed < 0)
2278         {
2279           /* Negative Content-Length; nonsensical, so we can't
2280              assume any information about the content to receive. */
2281           contlen = -1;
2282         }
2283       else
2284         contlen = parsed;
2285     }
2286
2287   /* Check for keep-alive related responses. */
2288   if (!inhibit_keep_alive && contlen != -1)
2289     {
2290       if (resp_header_copy (resp, "Connection", hdrval, sizeof (hdrval)))
2291         {
2292           if (0 == strcasecmp (hdrval, "Close"))
2293             keep_alive = false;
2294         }
2295     }
2296
2297   chunked_transfer_encoding = false;
2298   if (resp_header_copy (resp, "Transfer-Encoding", hdrval, sizeof (hdrval))
2299       && 0 == strcasecmp (hdrval, "chunked"))
2300     chunked_transfer_encoding = true;
2301
2302   /* Handle (possibly multiple instances of) the Set-Cookie header. */
2303   if (opt.cookies)
2304     {
2305       int scpos;
2306       const char *scbeg, *scend;
2307       /* The jar should have been created by now. */
2308       assert (wget_cookie_jar != NULL);
2309       for (scpos = 0;
2310            (scpos = resp_header_locate (resp, "Set-Cookie", scpos,
2311                                         &scbeg, &scend)) != -1;
2312            ++scpos)
2313         {
2314           char *set_cookie; BOUNDED_TO_ALLOCA (scbeg, scend, set_cookie);
2315           cookie_handle_set_cookie (wget_cookie_jar, u->host, u->port,
2316                                     u->path, set_cookie);
2317         }
2318     }
2319
2320   if (keep_alive)
2321     /* The server has promised that it will not close the connection
2322        when we're done.  This means that we can register it.  */
2323     register_persistent (conn->host, conn->port, sock, using_ssl);
2324
2325   if (statcode == HTTP_STATUS_UNAUTHORIZED)
2326     {
2327       /* Authorization is required.  */
2328
2329       /* Normally we are not interested in the response body.
2330          But if we are writing a WARC file we are: we like to keep everyting.  */
2331       if (warc_enabled)
2332         {
2333           int err;
2334           type = resp_header_strdup (resp, "Content-Type");
2335           err = read_response_body (hs, sock, NULL, contlen, 0,
2336                                     chunked_transfer_encoding,
2337                                     u->url, warc_timestamp_str,
2338                                     warc_request_uuid, warc_ip, type,
2339                                     statcode, head);
2340           xfree_null (type);
2341
2342           if (err != RETRFINISHED || hs->res < 0)
2343             {
2344               CLOSE_INVALIDATE (sock);
2345               request_free (req);
2346               xfree_null (message);
2347               resp_free (resp);
2348               xfree (head);
2349               return err;
2350             }
2351           else
2352             CLOSE_FINISH (sock);
2353         }
2354       else
2355         {
2356           /* Since WARC is disabled, we are not interested in the response body.  */
2357           if (keep_alive && !head_only
2358               && skip_short_body (sock, contlen, chunked_transfer_encoding))
2359             CLOSE_FINISH (sock);
2360           else
2361             CLOSE_INVALIDATE (sock);
2362         }
2363
2364       pconn.authorized = false;
2365       if (!auth_finished && (user && passwd))
2366         {
2367           /* IIS sends multiple copies of WWW-Authenticate, one with
2368              the value "negotiate", and other(s) with data.  Loop over
2369              all the occurrences and pick the one we recognize.  */
2370           int wapos;
2371           const char *wabeg, *waend;
2372           char *www_authenticate = NULL;
2373           for (wapos = 0;
2374                (wapos = resp_header_locate (resp, "WWW-Authenticate", wapos,
2375                                             &wabeg, &waend)) != -1;
2376                ++wapos)
2377             if (known_authentication_scheme_p (wabeg, waend))
2378               {
2379                 BOUNDED_TO_ALLOCA (wabeg, waend, www_authenticate);
2380                 break;
2381               }
2382
2383           if (!www_authenticate)
2384             {
2385               /* If the authentication header is missing or
2386                  unrecognized, there's no sense in retrying.  */
2387               logputs (LOG_NOTQUIET, _("Unknown authentication scheme.\n"));
2388             }
2389           else if (!basic_auth_finished
2390                    || !BEGINS_WITH (www_authenticate, "Basic"))
2391             {
2392               char *pth;
2393               pth = url_full_path (u);
2394               request_set_header (req, "Authorization",
2395                                   create_authorization_line (www_authenticate,
2396                                                              user, passwd,
2397                                                              request_method (req),
2398                                                              pth,
2399                                                              &auth_finished),
2400                                   rel_value);
2401               if (BEGINS_WITH (www_authenticate, "NTLM"))
2402                 ntlm_seen = true;
2403               else if (!u->user && BEGINS_WITH (www_authenticate, "Basic"))
2404                 {
2405                   /* Need to register this host as using basic auth,
2406                    * so we automatically send creds next time. */
2407                   register_basic_auth_host (u->host);
2408                 }
2409               xfree (pth);
2410               xfree_null (message);
2411               resp_free (resp);
2412               xfree (head);
2413               goto retry_with_auth;
2414             }
2415           else
2416             {
2417               /* We already did Basic auth, and it failed. Gotta
2418                * give up. */
2419             }
2420         }
2421       logputs (LOG_NOTQUIET, _("Authorization failed.\n"));
2422       request_free (req);
2423       xfree_null (message);
2424       resp_free (resp);
2425       xfree (head);
2426       return AUTHFAILED;
2427     }
2428   else /* statcode != HTTP_STATUS_UNAUTHORIZED */
2429     {
2430       /* Kludge: if NTLM is used, mark the TCP connection as authorized. */
2431       if (ntlm_seen)
2432         pconn.authorized = true;
2433     }
2434
2435   /* Determine the local filename if needed. Notice that if -O is used
2436    * hstat.local_file is set by http_loop to the argument of -O. */
2437   if (!hs->local_file)
2438     {
2439       char *local_file = NULL;
2440
2441       /* Honor Content-Disposition whether possible. */
2442       if (!opt.content_disposition
2443           || !resp_header_copy (resp, "Content-Disposition",
2444                                 hdrval, sizeof (hdrval))
2445           || !parse_content_disposition (hdrval, &local_file))
2446         {
2447           /* The Content-Disposition header is missing or broken.
2448            * Choose unique file name according to given URL. */
2449           hs->local_file = url_file_name (u, NULL);
2450         }
2451       else
2452         {
2453           DEBUGP (("Parsed filename from Content-Disposition: %s\n",
2454                   local_file));
2455           hs->local_file = url_file_name (u, local_file);
2456         }
2457     }
2458
2459   /* TODO: perform this check only once. */
2460   if (!hs->existence_checked && file_exists_p (hs->local_file))
2461     {
2462       if (opt.noclobber && !opt.output_document)
2463         {
2464           /* If opt.noclobber is turned on and file already exists, do not
2465              retrieve the file. But if the output_document was given, then this
2466              test was already done and the file didn't exist. Hence the !opt.output_document */
2467           get_file_flags (hs->local_file, dt);
2468           request_free (req);
2469           resp_free (resp);
2470           xfree (head);
2471           xfree_null (message);
2472           return RETRUNNEEDED;
2473         }
2474       else if (!ALLOW_CLOBBER)
2475         {
2476           char *unique = unique_name (hs->local_file, true);
2477           if (unique != hs->local_file)
2478             xfree (hs->local_file);
2479           hs->local_file = unique;
2480         }
2481     }
2482   hs->existence_checked = true;
2483
2484   /* Support timestamping */
2485   /* TODO: move this code out of gethttp. */
2486   if (opt.timestamping && !hs->timestamp_checked)
2487     {
2488       size_t filename_len = strlen (hs->local_file);
2489       char *filename_plus_orig_suffix = alloca (filename_len + sizeof (ORIG_SFX));
2490       bool local_dot_orig_file_exists = false;
2491       char *local_filename = NULL;
2492       struct_stat st;
2493
2494       if (opt.backup_converted)
2495         /* If -K is specified, we'll act on the assumption that it was specified
2496            last time these files were downloaded as well, and instead of just
2497            comparing local file X against server file X, we'll compare local
2498            file X.orig (if extant, else X) against server file X.  If -K
2499            _wasn't_ specified last time, or the server contains files called
2500            *.orig, -N will be back to not operating correctly with -k. */
2501         {
2502           /* Would a single s[n]printf() call be faster?  --dan
2503
2504              Definitely not.  sprintf() is horribly slow.  It's a
2505              different question whether the difference between the two
2506              affects a program.  Usually I'd say "no", but at one
2507              point I profiled Wget, and found that a measurable and
2508              non-negligible amount of time was lost calling sprintf()
2509              in url.c.  Replacing sprintf with inline calls to
2510              strcpy() and number_to_string() made a difference.
2511              --hniksic */
2512           memcpy (filename_plus_orig_suffix, hs->local_file, filename_len);
2513           memcpy (filename_plus_orig_suffix + filename_len,
2514                   ORIG_SFX, sizeof (ORIG_SFX));
2515
2516           /* Try to stat() the .orig file. */
2517           if (stat (filename_plus_orig_suffix, &st) == 0)
2518             {
2519               local_dot_orig_file_exists = true;
2520               local_filename = filename_plus_orig_suffix;
2521             }
2522         }
2523
2524       if (!local_dot_orig_file_exists)
2525         /* Couldn't stat() <file>.orig, so try to stat() <file>. */
2526         if (stat (hs->local_file, &st) == 0)
2527           local_filename = hs->local_file;
2528
2529       if (local_filename != NULL)
2530         /* There was a local file, so we'll check later to see if the version
2531            the server has is the same version we already have, allowing us to
2532            skip a download. */
2533         {
2534           hs->orig_file_name = xstrdup (local_filename);
2535           hs->orig_file_size = st.st_size;
2536           hs->orig_file_tstamp = st.st_mtime;
2537 #ifdef WINDOWS
2538           /* Modification time granularity is 2 seconds for Windows, so
2539              increase local time by 1 second for later comparison. */
2540           ++hs->orig_file_tstamp;
2541 #endif
2542         }
2543     }
2544
2545   request_free (req);
2546
2547   hs->statcode = statcode;
2548   if (statcode == -1)
2549     hs->error = xstrdup (_("Malformed status line"));
2550   else if (!*message)
2551     hs->error = xstrdup (_("(no description)"));
2552   else
2553     hs->error = xstrdup (message);
2554   xfree_null (message);
2555
2556   type = resp_header_strdup (resp, "Content-Type");
2557   if (type)
2558     {
2559       char *tmp = strchr (type, ';');
2560       if (tmp)
2561         {
2562           /* sXXXav: only needed if IRI support is enabled */
2563           char *tmp2 = tmp + 1;
2564
2565           while (tmp > type && c_isspace (tmp[-1]))
2566             --tmp;
2567           *tmp = '\0';
2568
2569           /* Try to get remote encoding if needed */
2570           if (opt.enable_iri && !opt.encoding_remote)
2571             {
2572               tmp = parse_charset (tmp2);
2573               if (tmp)
2574                 set_content_encoding (iri, tmp);
2575             }
2576         }
2577     }
2578   hs->newloc = resp_header_strdup (resp, "Location");
2579   hs->remote_time = resp_header_strdup (resp, "Last-Modified");
2580
2581   if (resp_header_copy (resp, "Content-Range", hdrval, sizeof (hdrval)))
2582     {
2583       wgint first_byte_pos, last_byte_pos, entity_length;
2584       if (parse_content_range (hdrval, &first_byte_pos, &last_byte_pos,
2585                                &entity_length))
2586         {
2587           contrange = first_byte_pos;
2588           contlen = last_byte_pos - first_byte_pos + 1;
2589         }
2590     }
2591   resp_free (resp);
2592
2593   /* 20x responses are counted among successful by default.  */
2594   if (H_20X (statcode))
2595     *dt |= RETROKF;
2596
2597   /* Return if redirected.  */
2598   if (H_REDIRECTED (statcode) || statcode == HTTP_STATUS_MULTIPLE_CHOICES)
2599     {
2600       /* RFC2068 says that in case of the 300 (multiple choices)
2601          response, the server can output a preferred URL through
2602          `Location' header; otherwise, the request should be treated
2603          like GET.  So, if the location is set, it will be a
2604          redirection; otherwise, just proceed normally.  */
2605       if (statcode == HTTP_STATUS_MULTIPLE_CHOICES && !hs->newloc)
2606         *dt |= RETROKF;
2607       else
2608         {
2609           logprintf (LOG_VERBOSE,
2610                      _("Location: %s%s\n"),
2611                      hs->newloc ? escnonprint_uri (hs->newloc) : _("unspecified"),
2612                      hs->newloc ? _(" [following]") : "");
2613  
2614           /* In case the caller cares to look...  */
2615           hs->len = 0;
2616           hs->res = 0;
2617           hs->restval = 0;
2618
2619           /* Normally we are not interested in the response body of a redirect.
2620              But if we are writing a WARC file we are: we like to keep everyting.  */
2621           if (warc_enabled)
2622             {
2623               int err = read_response_body (hs, sock, NULL, contlen, 0,
2624                                             chunked_transfer_encoding,
2625                                             u->url, warc_timestamp_str,
2626                                             warc_request_uuid, warc_ip, type,
2627                                             statcode, head);
2628
2629               if (err != RETRFINISHED || hs->res < 0)
2630                 {
2631                   CLOSE_INVALIDATE (sock);
2632                   xfree_null (type);
2633                   xfree (head);
2634                   return err;
2635                 }
2636               else
2637                 CLOSE_FINISH (sock);
2638             }
2639           else
2640             {
2641               /* Since WARC is disabled, we are not interested in the response body.  */
2642               if (keep_alive && !head_only
2643                   && skip_short_body (sock, contlen, chunked_transfer_encoding))
2644                 CLOSE_FINISH (sock);
2645               else
2646                 CLOSE_INVALIDATE (sock);
2647             }
2648
2649           xfree_null (type);
2650           xfree (head);
2651           /* From RFC2616: The status codes 303 and 307 have
2652              been added for servers that wish to make unambiguously
2653              clear which kind of reaction is expected of the client.
2654              
2655              A 307 should be redirected using the same method,
2656              in other words, a POST should be preserved and not
2657              converted to a GET in that case. */
2658           if (statcode == HTTP_STATUS_TEMPORARY_REDIRECT)
2659             return NEWLOCATION_KEEP_POST;
2660           return NEWLOCATION;
2661         }
2662     }
2663
2664   /* If content-type is not given, assume text/html.  This is because
2665      of the multitude of broken CGI's that "forget" to generate the
2666      content-type.  */
2667   if (!type ||
2668         0 == strncasecmp (type, TEXTHTML_S, strlen (TEXTHTML_S)) ||
2669         0 == strncasecmp (type, TEXTXHTML_S, strlen (TEXTXHTML_S)))
2670     *dt |= TEXTHTML;
2671   else
2672     *dt &= ~TEXTHTML;
2673
2674   if (type &&
2675       0 == strncasecmp (type, TEXTCSS_S, strlen (TEXTCSS_S)))
2676     *dt |= TEXTCSS;
2677   else
2678     *dt &= ~TEXTCSS;
2679
2680   if (opt.adjust_extension)
2681     {
2682       if (*dt & TEXTHTML)
2683         /* -E / --adjust-extension / adjust_extension = on was specified,
2684            and this is a text/html file.  If some case-insensitive
2685            variation on ".htm[l]" isn't already the file's suffix,
2686            tack on ".html". */
2687         {
2688           ensure_extension (hs, ".html", dt);
2689         }
2690       else if (*dt & TEXTCSS)
2691         {
2692           ensure_extension (hs, ".css", dt);
2693         }
2694     }
2695
2696   if (statcode == HTTP_STATUS_RANGE_NOT_SATISFIABLE
2697       || (!opt.timestamping && hs->restval > 0 && statcode == HTTP_STATUS_OK
2698           && contrange == 0 && contlen >= 0 && hs->restval >= contlen))
2699     {
2700       /* If `-c' is in use and the file has been fully downloaded (or
2701          the remote file has shrunk), Wget effectively requests bytes
2702          after the end of file and the server response with 416
2703          (or 200 with a <= Content-Length.  */
2704       logputs (LOG_VERBOSE, _("\
2705 \n    The file is already fully retrieved; nothing to do.\n\n"));
2706       /* In case the caller inspects. */
2707       hs->len = contlen;
2708       hs->res = 0;
2709       /* Mark as successfully retrieved. */
2710       *dt |= RETROKF;
2711       xfree_null (type);
2712       CLOSE_INVALIDATE (sock);        /* would be CLOSE_FINISH, but there
2713                                    might be more bytes in the body. */
2714       xfree (head);
2715       return RETRUNNEEDED;
2716     }
2717   if ((contrange != 0 && contrange != hs->restval)
2718       || (H_PARTIAL (statcode) && !contrange))
2719     {
2720       /* The Range request was somehow misunderstood by the server.
2721          Bail out.  */
2722       xfree_null (type);
2723       CLOSE_INVALIDATE (sock);
2724       xfree (head);
2725       return RANGEERR;
2726     }
2727   if (contlen == -1)
2728     hs->contlen = -1;
2729   else
2730     hs->contlen = contlen + contrange;
2731
2732   if (opt.verbose)
2733     {
2734       if (*dt & RETROKF)
2735         {
2736           /* No need to print this output if the body won't be
2737              downloaded at all, or if the original server response is
2738              printed.  */
2739           logputs (LOG_VERBOSE, _("Length: "));
2740           if (contlen != -1)
2741             {
2742               logputs (LOG_VERBOSE, number_to_static_string (contlen + contrange));
2743               if (contlen + contrange >= 1024)
2744                 logprintf (LOG_VERBOSE, " (%s)",
2745                            human_readable (contlen + contrange));
2746               if (contrange)
2747                 {
2748                   if (contlen >= 1024)
2749                     logprintf (LOG_VERBOSE, _(", %s (%s) remaining"),
2750                                number_to_static_string (contlen),
2751                                human_readable (contlen));
2752                   else
2753                     logprintf (LOG_VERBOSE, _(", %s remaining"),
2754                                number_to_static_string (contlen));
2755                 }
2756             }
2757           else
2758             logputs (LOG_VERBOSE,
2759                      opt.ignore_length ? _("ignored") : _("unspecified"));
2760           if (type)
2761             logprintf (LOG_VERBOSE, " [%s]\n", quotearg_style (escape_quoting_style, type));
2762           else
2763             logputs (LOG_VERBOSE, "\n");
2764         }
2765     }
2766
2767   /* Return if we have no intention of further downloading.  */
2768   if ((!(*dt & RETROKF) && !opt.content_on_error) || head_only)
2769     {
2770       /* In case the caller cares to look...  */
2771       hs->len = 0;
2772       hs->res = 0;
2773       hs->restval = 0;
2774
2775       /* Normally we are not interested in the response body of a error responses.
2776          But if we are writing a WARC file we are: we like to keep everyting.  */
2777       if (warc_enabled)
2778         {
2779           int err = read_response_body (hs, sock, NULL, contlen, 0,
2780                                         chunked_transfer_encoding,
2781                                         u->url, warc_timestamp_str,
2782                                         warc_request_uuid, warc_ip, type,
2783                                         statcode, head);
2784
2785           if (err != RETRFINISHED || hs->res < 0)
2786             {
2787               CLOSE_INVALIDATE (sock);
2788               xfree (head);
2789               xfree_null (type);
2790               return err;
2791             }
2792           else
2793             CLOSE_FINISH (sock);
2794         }
2795       else
2796         {
2797           /* Since WARC is disabled, we are not interested in the response body.  */
2798           if (head_only)
2799             /* Pre-1.10 Wget used CLOSE_INVALIDATE here.  Now we trust the
2800                servers not to send body in response to a HEAD request, and
2801                those that do will likely be caught by test_socket_open.
2802                If not, they can be worked around using
2803                `--no-http-keep-alive'.  */
2804             CLOSE_FINISH (sock);
2805           else if (keep_alive
2806                    && skip_short_body (sock, contlen, chunked_transfer_encoding))
2807             /* Successfully skipped the body; also keep using the socket. */
2808             CLOSE_FINISH (sock);
2809           else
2810             CLOSE_INVALIDATE (sock);
2811         }
2812
2813       xfree (head);
2814       xfree_null (type);
2815       return RETRFINISHED;
2816     }
2817
2818 /* 2005-06-17 SMS.
2819    For VMS, define common fopen() optional arguments.
2820 */
2821 #ifdef __VMS
2822 # define FOPEN_OPT_ARGS "fop=sqo", "acc", acc_cb, &open_id
2823 # define FOPEN_BIN_FLAG 3
2824 #else /* def __VMS */
2825 # define FOPEN_BIN_FLAG true
2826 #endif /* def __VMS [else] */
2827
2828   /* Open the local file.  */
2829   if (!output_stream)
2830     {
2831       mkalldirs (hs->local_file);
2832       if (opt.backups)
2833         rotate_backups (hs->local_file);
2834       if (hs->restval)
2835         {
2836 #ifdef __VMS
2837           int open_id;
2838
2839           open_id = 21;
2840           fp = fopen (hs->local_file, "ab", FOPEN_OPT_ARGS);
2841 #else /* def __VMS */
2842           fp = fopen (hs->local_file, "ab");
2843 #endif /* def __VMS [else] */
2844         }
2845       else if (ALLOW_CLOBBER || count > 0)
2846         {
2847           if (opt.unlink && file_exists_p (hs->local_file))
2848             {
2849               int res = unlink (hs->local_file);
2850               if (res < 0)
2851                 {
2852                   logprintf (LOG_NOTQUIET, "%s: %s\n", hs->local_file,
2853                              strerror (errno));
2854                   CLOSE_INVALIDATE (sock);
2855                   xfree (head);
2856       xfree_null (type);
2857                   return UNLINKERR;
2858                 }
2859             }
2860
2861 #ifdef __VMS
2862           int open_id;
2863
2864           open_id = 22;
2865           fp = fopen (hs->local_file, "wb", FOPEN_OPT_ARGS);
2866 #else /* def __VMS */
2867           fp = fopen (hs->local_file, "wb");
2868 #endif /* def __VMS [else] */
2869         }
2870       else
2871         {
2872           fp = fopen_excl (hs->local_file, FOPEN_BIN_FLAG);
2873           if (!fp && errno == EEXIST)
2874             {
2875               /* We cannot just invent a new name and use it (which is
2876                  what functions like unique_create typically do)
2877                  because we told the user we'd use this name.
2878                  Instead, return and retry the download.  */
2879               logprintf (LOG_NOTQUIET,
2880                          _("%s has sprung into existence.\n"),
2881                          hs->local_file);
2882               CLOSE_INVALIDATE (sock);
2883               xfree (head);
2884               xfree_null (type);
2885               return FOPEN_EXCL_ERR;
2886             }
2887         }
2888       if (!fp)
2889         {
2890           logprintf (LOG_NOTQUIET, "%s: %s\n", hs->local_file, strerror (errno));
2891           CLOSE_INVALIDATE (sock);
2892           xfree (head);
2893           xfree_null (type);
2894           return FOPENERR;
2895         }
2896     }
2897   else
2898     fp = output_stream;
2899
2900   /* Print fetch message, if opt.verbose.  */
2901   if (opt.verbose)
2902     {
2903       logprintf (LOG_NOTQUIET, _("Saving to: %s\n"),
2904                  HYPHENP (hs->local_file) ? quote ("STDOUT") : quote (hs->local_file));
2905     }
2906
2907
2908   err = read_response_body (hs, sock, fp, contlen, contrange,
2909                             chunked_transfer_encoding,
2910                             u->url, warc_timestamp_str,
2911                             warc_request_uuid, warc_ip, type,
2912                             statcode, head);
2913
2914   /* Now we no longer need to store the response header. */
2915   xfree (head);
2916   xfree_null (type);
2917
2918   if (hs->res >= 0)
2919     CLOSE_FINISH (sock);
2920   else
2921     CLOSE_INVALIDATE (sock);
2922
2923   if (!output_stream)
2924     fclose (fp);
2925
2926   return err;
2927 }
2928
2929 /* The genuine HTTP loop!  This is the part where the retrieval is
2930    retried, and retried, and retried, and...  */
2931 uerr_t
2932 http_loop (struct url *u, struct url *original_url, char **newloc,
2933            char **local_file, const char *referer, int *dt, struct url *proxy,
2934            struct iri *iri)
2935 {
2936   int count;
2937   bool got_head = false;         /* used for time-stamping and filename detection */
2938   bool time_came_from_head = false;
2939   bool got_name = false;
2940   char *tms;
2941   const char *tmrate;
2942   uerr_t err, ret = TRYLIMEXC;
2943   time_t tmr = -1;               /* remote time-stamp */
2944   struct http_stat hstat;        /* HTTP status */
2945   struct_stat st;
2946   bool send_head_first = true;
2947   char *file_name;
2948   bool force_full_retrieve = false;
2949
2950
2951   /* If we are writing to a WARC file: always retrieve the whole file. */
2952   if (opt.warc_filename != NULL)
2953     force_full_retrieve = true;
2954
2955
2956   /* Assert that no value for *LOCAL_FILE was passed. */
2957   assert (local_file == NULL || *local_file == NULL);
2958
2959   /* Set LOCAL_FILE parameter. */
2960   if (local_file && opt.output_document)
2961     *local_file = HYPHENP (opt.output_document) ? NULL : xstrdup (opt.output_document);
2962
2963   /* Reset NEWLOC parameter. */
2964   *newloc = NULL;
2965
2966   /* This used to be done in main(), but it's a better idea to do it
2967      here so that we don't go through the hoops if we're just using
2968      FTP or whatever. */
2969   if (opt.cookies)
2970     load_cookies ();
2971
2972   /* Warn on (likely bogus) wildcard usage in HTTP. */
2973   if (opt.ftp_glob && has_wildcards_p (u->path))
2974     logputs (LOG_VERBOSE, _("Warning: wildcards not supported in HTTP.\n"));
2975
2976   /* Setup hstat struct. */
2977   xzero (hstat);
2978   hstat.referer = referer;
2979
2980   if (opt.output_document)
2981     {
2982       hstat.local_file = xstrdup (opt.output_document);
2983       got_name = true;
2984     }
2985   else if (!opt.content_disposition)
2986     {
2987       hstat.local_file =
2988         url_file_name (opt.trustservernames ? u : original_url, NULL);
2989       got_name = true;
2990     }
2991
2992   if (got_name && file_exists_p (hstat.local_file) && opt.noclobber && !opt.output_document)
2993     {
2994       /* If opt.noclobber is turned on and file already exists, do not
2995          retrieve the file. But if the output_document was given, then this
2996          test was already done and the file didn't exist. Hence the !opt.output_document */
2997       get_file_flags (hstat.local_file, dt);
2998       ret = RETROK;
2999       goto exit;
3000     }
3001
3002   /* Reset the counter. */
3003   count = 0;
3004
3005   /* Reset the document type. */
3006   *dt = 0;
3007
3008   /* Skip preliminary HEAD request if we're not in spider mode.  */
3009   if (!opt.spider)
3010     send_head_first = false;
3011
3012   /* Send preliminary HEAD request if --content-disposition and -c are used
3013      together.  */
3014   if (opt.content_disposition && opt.always_rest)
3015     send_head_first = true;
3016
3017   /* Send preliminary HEAD request if -N is given and we have an existing
3018    * destination file. */
3019   file_name = url_file_name (opt.trustservernames ? u : original_url, NULL);
3020   if (opt.timestamping && (file_exists_p (file_name)
3021                            || opt.content_disposition))
3022     send_head_first = true;
3023   xfree (file_name);
3024
3025   /* THE loop */
3026   do
3027     {
3028       /* Increment the pass counter.  */
3029       ++count;
3030       sleep_between_retrievals (count);
3031
3032       /* Get the current time string.  */
3033       tms = datetime_str (time (NULL));
3034
3035       if (opt.spider && !got_head)
3036         logprintf (LOG_VERBOSE, _("\
3037 Spider mode enabled. Check if remote file exists.\n"));
3038
3039       /* Print fetch message, if opt.verbose.  */
3040       if (opt.verbose)
3041         {
3042           char *hurl = url_string (u, URL_AUTH_HIDE_PASSWD);
3043
3044           if (count > 1)
3045             {
3046               char tmp[256];
3047               sprintf (tmp, _("(try:%2d)"), count);
3048               logprintf (LOG_NOTQUIET, "--%s--  %s  %s\n",
3049                          tms, tmp, hurl);
3050             }
3051           else
3052             {
3053               logprintf (LOG_NOTQUIET, "--%s--  %s\n",
3054                          tms, hurl);
3055             }
3056
3057 #ifdef WINDOWS
3058           ws_changetitle (hurl);
3059 #endif
3060           xfree (hurl);
3061         }
3062
3063       /* Default document type is empty.  However, if spider mode is
3064          on or time-stamping is employed, HEAD_ONLY commands is
3065          encoded within *dt.  */
3066       if (send_head_first && !got_head)
3067         *dt |= HEAD_ONLY;
3068       else
3069         *dt &= ~HEAD_ONLY;
3070
3071       /* Decide whether or not to restart.  */
3072       if (force_full_retrieve)
3073         hstat.restval = hstat.len;
3074       else if (opt.always_rest
3075           && got_name
3076           && stat (hstat.local_file, &st) == 0
3077           && S_ISREG (st.st_mode))
3078         /* When -c is used, continue from on-disk size.  (Can't use
3079            hstat.len even if count>1 because we don't want a failed
3080            first attempt to clobber existing data.)  */
3081         hstat.restval = st.st_size;
3082       else if (count > 1)
3083         /* otherwise, continue where the previous try left off */
3084         hstat.restval = hstat.len;
3085       else
3086         hstat.restval = 0;
3087
3088       /* Decide whether to send the no-cache directive.  We send it in
3089          two cases:
3090            a) we're using a proxy, and we're past our first retrieval.
3091               Some proxies are notorious for caching incomplete data, so
3092               we require a fresh get.
3093            b) caching is explicitly inhibited. */
3094       if ((proxy && count > 1)        /* a */
3095           || !opt.allow_cache)        /* b */
3096         *dt |= SEND_NOCACHE;
3097       else
3098         *dt &= ~SEND_NOCACHE;
3099
3100       /* Try fetching the document, or at least its head.  */
3101       err = gethttp (u, &hstat, dt, proxy, iri, count);
3102
3103       /* Time?  */
3104       tms = datetime_str (time (NULL));
3105
3106       /* Get the new location (with or without the redirection).  */
3107       if (hstat.newloc)
3108         *newloc = xstrdup (hstat.newloc);
3109
3110       switch (err)
3111         {
3112         case HERR: case HEOF: case CONSOCKERR: case CONCLOSED:
3113         case CONERROR: case READERR: case WRITEFAILED:
3114         case RANGEERR: case FOPEN_EXCL_ERR:
3115           /* Non-fatal errors continue executing the loop, which will
3116              bring them to "while" statement at the end, to judge
3117              whether the number of tries was exceeded.  */
3118           printwhat (count, opt.ntry);
3119           continue;
3120         case FWRITEERR: case FOPENERR:
3121           /* Another fatal error.  */
3122           logputs (LOG_VERBOSE, "\n");
3123           logprintf (LOG_NOTQUIET, _("Cannot write to %s (%s).\n"),
3124                      quote (hstat.local_file), strerror (errno));
3125         case HOSTERR: case CONIMPOSSIBLE: case PROXERR: case AUTHFAILED:
3126         case SSLINITFAILED: case CONTNOTSUPPORTED: case VERIFCERTERR:
3127         case FILEBADFILE:
3128           /* Fatal errors just return from the function.  */
3129           ret = err;
3130           goto exit;
3131         case WARC_ERR:
3132           /* A fatal WARC error. */
3133           logputs (LOG_VERBOSE, "\n");
3134           logprintf (LOG_NOTQUIET, _("Cannot write to WARC file.\n"));
3135           ret = err;
3136           goto exit;
3137         case WARC_TMP_FOPENERR: case WARC_TMP_FWRITEERR:
3138           /* A fatal WARC error. */
3139           logputs (LOG_VERBOSE, "\n");
3140           logprintf (LOG_NOTQUIET, _("Cannot write to temporary WARC file.\n"));
3141           ret = err;
3142           goto exit;
3143         case CONSSLERR:
3144           /* Another fatal error.  */
3145           logprintf (LOG_NOTQUIET, _("Unable to establish SSL connection.\n"));
3146           ret = err;
3147           goto exit;
3148         case UNLINKERR:
3149           /* Another fatal error.  */
3150           logputs (LOG_VERBOSE, "\n");
3151           logprintf (LOG_NOTQUIET, _("Cannot unlink %s (%s).\n"),
3152                      quote (hstat.local_file), strerror (errno));
3153           ret = err;
3154           goto exit;
3155         case NEWLOCATION:
3156         case NEWLOCATION_KEEP_POST:
3157           /* Return the new location to the caller.  */
3158           if (!*newloc)
3159             {
3160               logprintf (LOG_NOTQUIET,
3161                          _("ERROR: Redirection (%d) without location.\n"),
3162                          hstat.statcode);
3163               ret = WRONGCODE;
3164             }
3165           else
3166             {
3167               ret = err;
3168             }
3169           goto exit;
3170         case RETRUNNEEDED:
3171           /* The file was already fully retrieved. */
3172           ret = RETROK;
3173           goto exit;
3174         case RETRFINISHED:
3175           /* Deal with you later.  */
3176           break;
3177         default:
3178           /* All possibilities should have been exhausted.  */
3179           abort ();
3180         }
3181
3182       if (!(*dt & RETROKF))
3183         {
3184           char *hurl = NULL;
3185           if (!opt.verbose)
3186             {
3187               /* #### Ugly ugly ugly! */
3188               hurl = url_string (u, URL_AUTH_HIDE_PASSWD);
3189               logprintf (LOG_NONVERBOSE, "%s:\n", hurl);
3190             }
3191
3192           /* Fall back to GET if HEAD fails with a 500 or 501 error code. */
3193           if (*dt & HEAD_ONLY
3194               && (hstat.statcode == 500 || hstat.statcode == 501))
3195             {
3196               got_head = true;
3197               continue;
3198             }
3199           /* Maybe we should always keep track of broken links, not just in
3200            * spider mode.
3201            * Don't log error if it was UTF-8 encoded because we will try
3202            * once unencoded. */
3203           else if (opt.spider && !iri->utf8_encode)
3204             {
3205               /* #### Again: ugly ugly ugly! */
3206               if (!hurl)
3207                 hurl = url_string (u, URL_AUTH_HIDE_PASSWD);
3208               nonexisting_url (hurl);
3209               logprintf (LOG_NOTQUIET, _("\
3210 Remote file does not exist -- broken link!!!\n"));
3211             }
3212           else
3213             {
3214               logprintf (LOG_NOTQUIET, _("%s ERROR %d: %s.\n"),
3215                          tms, hstat.statcode,
3216                          quotearg_style (escape_quoting_style, hstat.error));
3217             }
3218           logputs (LOG_VERBOSE, "\n");
3219           ret = WRONGCODE;
3220           xfree_null (hurl);
3221           goto exit;
3222         }
3223
3224       /* Did we get the time-stamp? */
3225       if (!got_head)
3226         {
3227           got_head = true;    /* no more time-stamping */
3228
3229           if (opt.timestamping && !hstat.remote_time)
3230             {
3231               logputs (LOG_NOTQUIET, _("\
3232 Last-modified header missing -- time-stamps turned off.\n"));
3233             }
3234           else if (hstat.remote_time)
3235             {
3236               /* Convert the date-string into struct tm.  */
3237               tmr = http_atotm (hstat.remote_time);
3238               if (tmr == (time_t) (-1))
3239                 logputs (LOG_VERBOSE, _("\
3240 Last-modified header invalid -- time-stamp ignored.\n"));
3241               if (*dt & HEAD_ONLY)
3242                 time_came_from_head = true;
3243             }
3244
3245           if (send_head_first)
3246             {
3247               /* The time-stamping section.  */
3248               if (opt.timestamping)
3249                 {
3250                   if (hstat.orig_file_name) /* Perform the following
3251                                                checks only if the file
3252                                                we're supposed to
3253                                                download already exists.  */
3254                     {
3255                       if (hstat.remote_time &&
3256                           tmr != (time_t) (-1))
3257                         {
3258                           /* Now time-stamping can be used validly.
3259                              Time-stamping means that if the sizes of
3260                              the local and remote file match, and local
3261                              file is newer than the remote file, it will
3262                              not be retrieved.  Otherwise, the normal
3263                              download procedure is resumed.  */
3264                           if (hstat.orig_file_tstamp >= tmr)
3265                             {
3266                               if (hstat.contlen == -1
3267                                   || hstat.orig_file_size == hstat.contlen)
3268                                 {
3269                                   logprintf (LOG_VERBOSE, _("\
3270 Server file no newer than local file %s -- not retrieving.\n\n"),
3271                                              quote (hstat.orig_file_name));
3272                                   ret = RETROK;
3273                                   goto exit;
3274                                 }
3275                               else
3276                                 {
3277                                   logprintf (LOG_VERBOSE, _("\
3278 The sizes do not match (local %s) -- retrieving.\n"),
3279                                              number_to_static_string (hstat.orig_file_size));
3280                                 }
3281                             }
3282                           else
3283                             {
3284                               force_full_retrieve = true;
3285                               logputs (LOG_VERBOSE,
3286                                        _("Remote file is newer, retrieving.\n"));
3287                             }
3288
3289                           logputs (LOG_VERBOSE, "\n");
3290                         }
3291                     }
3292
3293                   /* free_hstat (&hstat); */
3294                   hstat.timestamp_checked = true;
3295                 }
3296
3297               if (opt.spider)
3298                 {
3299                   bool finished = true;
3300                   if (opt.recursive)
3301                     {
3302                       if (*dt & TEXTHTML)
3303                         {
3304                           logputs (LOG_VERBOSE, _("\
3305 Remote file exists and could contain links to other resources -- retrieving.\n\n"));
3306                           finished = false;
3307                         }
3308                       else
3309                         {
3310                           logprintf (LOG_VERBOSE, _("\
3311 Remote file exists but does not contain any link -- not retrieving.\n\n"));
3312                           ret = RETROK; /* RETRUNNEEDED is not for caller. */
3313                         }
3314                     }
3315                   else
3316                     {
3317                       if (*dt & TEXTHTML)
3318                         {
3319                           logprintf (LOG_VERBOSE, _("\
3320 Remote file exists and could contain further links,\n\
3321 but recursion is disabled -- not retrieving.\n\n"));
3322                         }
3323                       else
3324                         {
3325                           logprintf (LOG_VERBOSE, _("\
3326 Remote file exists.\n\n"));
3327                         }
3328                       ret = RETROK; /* RETRUNNEEDED is not for caller. */
3329                     }
3330
3331                   if (finished)
3332                     {
3333                       logprintf (LOG_NONVERBOSE,
3334                                  _("%s URL: %s %2d %s\n"),
3335                                  tms, u->url, hstat.statcode,
3336                                  hstat.message ? quotearg_style (escape_quoting_style, hstat.message) : "");
3337                       goto exit;
3338                     }
3339                 }
3340
3341               got_name = true;
3342               *dt &= ~HEAD_ONLY;
3343               count = 0;          /* the retrieve count for HEAD is reset */
3344               continue;
3345             } /* send_head_first */
3346         } /* !got_head */
3347
3348       if (opt.useservertimestamps
3349           && (tmr != (time_t) (-1))
3350           && ((hstat.len == hstat.contlen) ||
3351               ((hstat.res == 0) && (hstat.contlen == -1))))
3352         {
3353           const char *fl = NULL;
3354           set_local_file (&fl, hstat.local_file);
3355           if (fl)
3356             {
3357               time_t newtmr = -1;
3358               /* Reparse time header, in case it's changed. */
3359               if (time_came_from_head
3360                   && hstat.remote_time && hstat.remote_time[0])
3361                 {
3362                   newtmr = http_atotm (hstat.remote_time);
3363                   if (newtmr != (time_t)-1)
3364                     tmr = newtmr;
3365                 }
3366               touch (fl, tmr);
3367             }
3368         }
3369       /* End of time-stamping section. */
3370
3371       tmrate = retr_rate (hstat.rd_size, hstat.dltime);
3372       total_download_time += hstat.dltime;
3373
3374       if (hstat.len == hstat.contlen)
3375         {
3376           if (*dt & RETROKF)
3377             {
3378               bool write_to_stdout = (opt.output_document && HYPHENP (opt.output_document));
3379
3380               logprintf (LOG_VERBOSE,
3381                          write_to_stdout
3382                          ? _("%s (%s) - written to stdout %s[%s/%s]\n\n")
3383                          : _("%s (%s) - %s saved [%s/%s]\n\n"),
3384                          tms, tmrate,
3385                          write_to_stdout ? "" : quote (hstat.local_file),
3386                          number_to_static_string (hstat.len),
3387                          number_to_static_string (hstat.contlen));
3388               logprintf (LOG_NONVERBOSE,
3389                          "%s URL:%s [%s/%s] -> \"%s\" [%d]\n",
3390                          tms, u->url,
3391                          number_to_static_string (hstat.len),
3392                          number_to_static_string (hstat.contlen),
3393                          hstat.local_file, count);
3394             }
3395           ++numurls;
3396           total_downloaded_bytes += hstat.rd_size;
3397
3398           /* Remember that we downloaded the file for later ".orig" code. */
3399           if (*dt & ADDED_HTML_EXTENSION)
3400             downloaded_file (FILE_DOWNLOADED_AND_HTML_EXTENSION_ADDED, hstat.local_file);
3401           else
3402             downloaded_file (FILE_DOWNLOADED_NORMALLY, hstat.local_file);
3403
3404           ret = RETROK;
3405           goto exit;
3406         }
3407       else if (hstat.res == 0) /* No read error */
3408         {
3409           if (hstat.contlen == -1)  /* We don't know how much we were supposed
3410                                        to get, so assume we succeeded. */
3411             {
3412               if (*dt & RETROKF)
3413                 {
3414                   bool write_to_stdout = (opt.output_document && HYPHENP (opt.output_document));
3415
3416                   logprintf (LOG_VERBOSE,
3417                              write_to_stdout
3418                              ? _("%s (%s) - written to stdout %s[%s]\n\n")
3419                              : _("%s (%s) - %s saved [%s]\n\n"),
3420                              tms, tmrate,
3421                              write_to_stdout ? "" : quote (hstat.local_file),
3422                              number_to_static_string (hstat.len));
3423                   logprintf (LOG_NONVERBOSE,
3424                              "%s URL:%s [%s] -> \"%s\" [%d]\n",
3425                              tms, u->url, number_to_static_string (hstat.len),
3426                              hstat.local_file, count);
3427                 }
3428               ++numurls;
3429               total_downloaded_bytes += hstat.rd_size;
3430
3431               /* Remember that we downloaded the file for later ".orig" code. */
3432               if (*dt & ADDED_HTML_EXTENSION)
3433                 downloaded_file (FILE_DOWNLOADED_AND_HTML_EXTENSION_ADDED, hstat.local_file);
3434               else
3435                 downloaded_file (FILE_DOWNLOADED_NORMALLY, hstat.local_file);
3436
3437               ret = RETROK;
3438               goto exit;
3439             }
3440           else if (hstat.len < hstat.contlen) /* meaning we lost the
3441                                                  connection too soon */
3442             {
3443               logprintf (LOG_VERBOSE,
3444                          _("%s (%s) - Connection closed at byte %s. "),
3445                          tms, tmrate, number_to_static_string (hstat.len));
3446               printwhat (count, opt.ntry);
3447               continue;
3448             }
3449           else if (hstat.len != hstat.restval)
3450             /* Getting here would mean reading more data than
3451                requested with content-length, which we never do.  */
3452             abort ();
3453           else
3454             {
3455               /* Getting here probably means that the content-length was
3456                * _less_ than the original, local size. We should probably
3457                * truncate or re-read, or something. FIXME */
3458               ret = RETROK;
3459               goto exit;
3460             }
3461         }
3462       else /* from now on hstat.res can only be -1 */
3463         {
3464           if (hstat.contlen == -1)
3465             {
3466               logprintf (LOG_VERBOSE,
3467                          _("%s (%s) - Read error at byte %s (%s)."),
3468                          tms, tmrate, number_to_static_string (hstat.len),
3469                          hstat.rderrmsg);
3470               printwhat (count, opt.ntry);
3471               continue;
3472             }
3473           else /* hstat.res == -1 and contlen is given */
3474             {
3475               logprintf (LOG_VERBOSE,
3476                          _("%s (%s) - Read error at byte %s/%s (%s). "),
3477                          tms, tmrate,
3478                          number_to_static_string (hstat.len),
3479                          number_to_static_string (hstat.contlen),
3480                          hstat.rderrmsg);
3481               printwhat (count, opt.ntry);
3482               continue;
3483             }
3484         }
3485       /* not reached */
3486     }
3487   while (!opt.ntry || (count < opt.ntry));
3488
3489 exit:
3490   if (ret == RETROK && local_file)
3491     *local_file = xstrdup (hstat.local_file);
3492   free_hstat (&hstat);
3493
3494   return ret;
3495 }
3496 \f
3497 /* Check whether the result of strptime() indicates success.
3498    strptime() returns the pointer to how far it got to in the string.
3499    The processing has been successful if the string is at `GMT' or
3500    `+X', or at the end of the string.
3501
3502    In extended regexp parlance, the function returns 1 if P matches
3503    "^ *(GMT|[+-][0-9]|$)", 0 otherwise.  P being NULL (which strptime
3504    can return) is considered a failure and 0 is returned.  */
3505 static bool
3506 check_end (const char *p)
3507 {
3508   if (!p)
3509     return false;
3510   while (c_isspace (*p))
3511     ++p;
3512   if (!*p
3513       || (p[0] == 'G' && p[1] == 'M' && p[2] == 'T')
3514       || ((p[0] == '+' || p[0] == '-') && c_isdigit (p[1])))
3515     return true;
3516   else
3517     return false;
3518 }
3519
3520 /* Convert the textual specification of time in TIME_STRING to the
3521    number of seconds since the Epoch.
3522
3523    TIME_STRING can be in any of the three formats RFC2616 allows the
3524    HTTP servers to emit -- RFC1123-date, RFC850-date or asctime-date,
3525    as well as the time format used in the Set-Cookie header.
3526    Timezones are ignored, and should be GMT.
3527
3528    Return the computed time_t representation, or -1 if the conversion
3529    fails.
3530
3531    This function uses strptime with various string formats for parsing
3532    TIME_STRING.  This results in a parser that is not as lenient in
3533    interpreting TIME_STRING as I would like it to be.  Being based on
3534    strptime, it always allows shortened months, one-digit days, etc.,
3535    but due to the multitude of formats in which time can be
3536    represented, an ideal HTTP time parser would be even more
3537    forgiving.  It should completely ignore things like week days and
3538    concentrate only on the various forms of representing years,
3539    months, days, hours, minutes, and seconds.  For example, it would
3540    be nice if it accepted ISO 8601 out of the box.
3541
3542    I've investigated free and PD code for this purpose, but none was
3543    usable.  getdate was big and unwieldy, and had potential copyright
3544    issues, or so I was informed.  Dr. Marcus Hennecke's atotm(),
3545    distributed with phttpd, is excellent, but we cannot use it because
3546    it is not assigned to the FSF.  So I stuck it with strptime.  */
3547
3548 time_t
3549 http_atotm (const char *time_string)
3550 {
3551   /* NOTE: Solaris strptime man page claims that %n and %t match white
3552      space, but that's not universally available.  Instead, we simply
3553      use ` ' to mean "skip all WS", which works under all strptime
3554      implementations I've tested.  */
3555
3556   static const char *time_formats[] = {
3557     "%a, %d %b %Y %T",          /* rfc1123: Thu, 29 Jan 1998 22:12:57 */
3558     "%A, %d-%b-%y %T",          /* rfc850:  Thursday, 29-Jan-98 22:12:57 */
3559     "%a %b %d %T %Y",           /* asctime: Thu Jan 29 22:12:57 1998 */
3560     "%a, %d-%b-%Y %T"           /* cookies: Thu, 29-Jan-1998 22:12:57
3561                                    (used in Set-Cookie, defined in the
3562                                    Netscape cookie specification.) */
3563   };
3564   const char *oldlocale;
3565   char savedlocale[256];
3566   size_t i;
3567   time_t ret = (time_t) -1;
3568
3569   /* Solaris strptime fails to recognize English month names in
3570      non-English locales, which we work around by temporarily setting
3571      locale to C before invoking strptime.  */
3572   oldlocale = setlocale (LC_TIME, NULL);
3573   if (oldlocale)
3574     {
3575       size_t l = strlen (oldlocale) + 1;
3576       if (l >= sizeof savedlocale)
3577         savedlocale[0] = '\0';
3578       else
3579         memcpy (savedlocale, oldlocale, l);
3580     }
3581   else savedlocale[0] = '\0';
3582
3583   setlocale (LC_TIME, "C");
3584
3585   for (i = 0; i < countof (time_formats); i++)
3586     {
3587       struct tm t;
3588
3589       /* Some versions of strptime use the existing contents of struct
3590          tm to recalculate the date according to format.  Zero it out
3591          to prevent stack garbage from influencing strptime.  */
3592       xzero (t);
3593
3594       if (check_end (strptime (time_string, time_formats[i], &t)))
3595         {
3596           ret = timegm (&t);
3597           break;
3598         }
3599     }
3600
3601   /* Restore the previous locale. */
3602   if (savedlocale[0])
3603     setlocale (LC_TIME, savedlocale);
3604
3605   return ret;
3606 }
3607 \f
3608 /* Authorization support: We support three authorization schemes:
3609
3610    * `Basic' scheme, consisting of base64-ing USER:PASSWORD string;
3611
3612    * `Digest' scheme, added by Junio Hamano <junio@twinsun.com>,
3613    consisting of answering to the server's challenge with the proper
3614    MD5 digests.
3615
3616    * `NTLM' ("NT Lan Manager") scheme, based on code written by Daniel
3617    Stenberg for libcurl.  Like digest, NTLM is based on a
3618    challenge-response mechanism, but unlike digest, it is non-standard
3619    (authenticates TCP connections rather than requests), undocumented
3620    and Microsoft-specific.  */
3621
3622 /* Create the authentication header contents for the `Basic' scheme.
3623    This is done by encoding the string "USER:PASS" to base64 and
3624    prepending the string "Basic " in front of it.  */
3625
3626 static char *
3627 basic_authentication_encode (const char *user, const char *passwd)
3628 {
3629   char *t1, *t2;
3630   int len1 = strlen (user) + 1 + strlen (passwd);
3631
3632   t1 = (char *)alloca (len1 + 1);
3633   sprintf (t1, "%s:%s", user, passwd);
3634
3635   t2 = (char *)alloca (BASE64_LENGTH (len1) + 1);
3636   base64_encode (t1, len1, t2);
3637
3638   return concat_strings ("Basic ", t2, (char *) 0);
3639 }
3640
3641 #define SKIP_WS(x) do {                         \
3642   while (c_isspace (*(x)))                        \
3643     ++(x);                                      \
3644 } while (0)
3645
3646 #ifdef ENABLE_DIGEST
3647 /* Dump the hexadecimal representation of HASH to BUF.  HASH should be
3648    an array of 16 bytes containing the hash keys, and BUF should be a
3649    buffer of 33 writable characters (32 for hex digits plus one for
3650    zero termination).  */
3651 static void
3652 dump_hash (char *buf, const unsigned char *hash)
3653 {
3654   int i;
3655
3656   for (i = 0; i < MD5_DIGEST_SIZE; i++, hash++)
3657     {
3658       *buf++ = XNUM_TO_digit (*hash >> 4);
3659       *buf++ = XNUM_TO_digit (*hash & 0xf);
3660     }
3661   *buf = '\0';
3662 }
3663
3664 /* Take the line apart to find the challenge, and compose a digest
3665    authorization header.  See RFC2069 section 2.1.2.  */
3666 static char *
3667 digest_authentication_encode (const char *au, const char *user,
3668                               const char *passwd, const char *method,
3669                               const char *path)
3670 {
3671   static char *realm, *opaque, *nonce, *qop, *algorithm;
3672   static struct {
3673     const char *name;
3674     char **variable;
3675   } options[] = {
3676     { "realm", &realm },
3677     { "opaque", &opaque },
3678     { "nonce", &nonce },
3679     { "qop", &qop },
3680     { "algorithm", &algorithm }
3681   };
3682   char cnonce[16] = "";
3683   char *res;
3684   int res_len;
3685   size_t res_size;
3686   param_token name, value;
3687
3688
3689   realm = opaque = nonce = qop = algorithm = NULL;
3690
3691   au += 6;                      /* skip over `Digest' */
3692   while (extract_param (&au, &name, &value, ','))
3693     {
3694       size_t i;
3695       size_t namelen = name.e - name.b;
3696       for (i = 0; i < countof (options); i++)
3697         if (namelen == strlen (options[i].name)
3698             && 0 == strncmp (name.b, options[i].name,
3699                              namelen))
3700           {
3701             *options[i].variable = strdupdelim (value.b, value.e);
3702             break;
3703           }
3704     }
3705
3706   if (qop != NULL && strcmp(qop,"auth"))
3707     {
3708       logprintf (LOG_NOTQUIET, _("Unsupported quality of protection '%s'.\n"), qop);
3709       user = NULL; /* force freeing mem and return */
3710     }
3711
3712   if (algorithm != NULL && strcmp (algorithm,"MD5") && strcmp (algorithm,"MD5-sess"))
3713     {
3714       logprintf (LOG_NOTQUIET, _("Unsupported algorithm '%s'.\n"), algorithm);
3715       user = NULL; /* force freeing mem and return */
3716     }
3717
3718   if (!realm || !nonce || !user || !passwd || !path || !method)
3719     {
3720       xfree_null (realm);
3721       xfree_null (opaque);
3722       xfree_null (nonce);
3723       xfree_null (qop);
3724       xfree_null (algorithm);
3725       return NULL;
3726     }
3727
3728   /* Calculate the digest value.  */
3729   {
3730     struct md5_ctx ctx;
3731     unsigned char hash[MD5_DIGEST_SIZE];
3732     char a1buf[MD5_DIGEST_SIZE * 2 + 1], a2buf[MD5_DIGEST_SIZE * 2 + 1];
3733     char response_digest[MD5_DIGEST_SIZE * 2 + 1];
3734
3735     /* A1BUF = H(user ":" realm ":" password) */
3736     md5_init_ctx (&ctx);
3737     md5_process_bytes ((unsigned char *)user, strlen (user), &ctx);
3738     md5_process_bytes ((unsigned char *)":", 1, &ctx);
3739     md5_process_bytes ((unsigned char *)realm, strlen (realm), &ctx);
3740     md5_process_bytes ((unsigned char *)":", 1, &ctx);
3741     md5_process_bytes ((unsigned char *)passwd, strlen (passwd), &ctx);
3742     md5_finish_ctx (&ctx, hash);
3743
3744     dump_hash (a1buf, hash);
3745
3746     if (! strcmp (algorithm, "MD5-sess"))
3747       {
3748         /* A1BUF = H( H(user ":" realm ":" password) ":" nonce ":" cnonce ) */
3749         snprintf (cnonce, sizeof (cnonce), "%08x", random_number(INT_MAX));
3750
3751         md5_init_ctx (&ctx);
3752         // md5_process_bytes (hash, MD5_DIGEST_SIZE, &ctx);
3753         md5_process_bytes (a1buf, MD5_DIGEST_SIZE * 2, &ctx);
3754         md5_process_bytes ((unsigned char *)":", 1, &ctx);
3755         md5_process_bytes ((unsigned char *)nonce, strlen (nonce), &ctx);
3756         md5_process_bytes ((unsigned char *)":", 1, &ctx);
3757         md5_process_bytes ((unsigned char *)cnonce, strlen (cnonce), &ctx);
3758         md5_finish_ctx (&ctx, hash);
3759
3760         dump_hash (a1buf, hash);
3761       }
3762
3763     /* A2BUF = H(method ":" path) */
3764     md5_init_ctx (&ctx);
3765     md5_process_bytes ((unsigned char *)method, strlen (method), &ctx);
3766     md5_process_bytes ((unsigned char *)":", 1, &ctx);
3767     md5_process_bytes ((unsigned char *)path, strlen (path), &ctx);
3768     md5_finish_ctx (&ctx, hash);
3769     dump_hash (a2buf, hash);
3770
3771     if (!strcmp(qop, "auth") || !strcmp (qop, "auth-int"))
3772       {
3773         /* RFC 2617 Digest Access Authentication */
3774         /* generate random hex string */
3775         if (!*cnonce)
3776           snprintf(cnonce, sizeof(cnonce), "%08x", random_number(INT_MAX));
3777
3778         /* RESPONSE_DIGEST = H(A1BUF ":" nonce ":" noncecount ":" clientnonce ":" qop ": " A2BUF) */
3779         md5_init_ctx (&ctx);
3780         md5_process_bytes ((unsigned char *)a1buf, MD5_DIGEST_SIZE * 2, &ctx);
3781         md5_process_bytes ((unsigned char *)":", 1, &ctx);
3782         md5_process_bytes ((unsigned char *)nonce, strlen (nonce), &ctx);
3783         md5_process_bytes ((unsigned char *)":", 1, &ctx);
3784         md5_process_bytes ((unsigned char *)"00000001", 8, &ctx); /* TODO: keep track of server nonce values */
3785         md5_process_bytes ((unsigned char *)":", 1, &ctx);
3786         md5_process_bytes ((unsigned char *)cnonce, strlen(cnonce), &ctx);
3787         md5_process_bytes ((unsigned char *)":", 1, &ctx);
3788         md5_process_bytes ((unsigned char *)qop, strlen(qop), &ctx);
3789         md5_process_bytes ((unsigned char *)":", 1, &ctx);
3790         md5_process_bytes ((unsigned char *)a2buf, MD5_DIGEST_SIZE * 2, &ctx);
3791         md5_finish_ctx (&ctx, hash);
3792       }
3793     else
3794       {
3795         /* RFC 2069 Digest Access Authentication */
3796         /* RESPONSE_DIGEST = H(A1BUF ":" nonce ":" A2BUF) */
3797         md5_init_ctx (&ctx);
3798         md5_process_bytes ((unsigned char *)a1buf, MD5_DIGEST_SIZE * 2, &ctx);
3799         md5_process_bytes ((unsigned char *)":", 1, &ctx);
3800         md5_process_bytes ((unsigned char *)nonce, strlen (nonce), &ctx);
3801         md5_process_bytes ((unsigned char *)":", 1, &ctx);
3802         md5_process_bytes ((unsigned char *)a2buf, MD5_DIGEST_SIZE * 2, &ctx);
3803         md5_finish_ctx (&ctx, hash);
3804       }
3805
3806     dump_hash (response_digest, hash);
3807
3808     res_size = strlen (user)
3809              + strlen (realm)
3810              + strlen (nonce)
3811              + strlen (path)
3812              + 2 * MD5_DIGEST_SIZE /*strlen (response_digest)*/
3813              + (opaque ? strlen (opaque) : 0)
3814              + (algorithm ? strlen (algorithm) : 0)
3815              + (qop ? 128: 0)
3816              + strlen (cnonce)
3817              + 128;
3818
3819     res = xmalloc (res_size);
3820
3821     if (!strcmp(qop,"auth"))
3822       {
3823         res_len = snprintf (res, res_size, "Digest "\
3824                 "username=\"%s\", realm=\"%s\", nonce=\"%s\", uri=\"%s\", response=\"%s\""\
3825                 ", qop=auth, nc=00000001, cnonce=\"%s\"",
3826                   user, realm, nonce, path, response_digest, cnonce);
3827
3828       }
3829     else
3830       {
3831         res_len = snprintf (res, res_size, "Digest "\
3832                 "username=\"%s\", realm=\"%s\", nonce=\"%s\", uri=\"%s\", response=\"%s\"",
3833                   user, realm, nonce, path, response_digest);
3834       }
3835
3836     if (opaque)
3837       {
3838         res_len += snprintf(res + res_len, res_size - res_len, ", opaque=\"%s\"", opaque);
3839       }
3840
3841     if (algorithm)
3842       {
3843         snprintf(res + res_len, res_size - res_len, ", algorithm=\"%s\"", algorithm);
3844       }
3845   }
3846   return res;
3847 }
3848 #endif /* ENABLE_DIGEST */
3849
3850 /* Computing the size of a string literal must take into account that
3851    value returned by sizeof includes the terminating \0.  */
3852 #define STRSIZE(literal) (sizeof (literal) - 1)
3853
3854 /* Whether chars in [b, e) begin with the literal string provided as
3855    first argument and are followed by whitespace or terminating \0.
3856    The comparison is case-insensitive.  */
3857 #define STARTS(literal, b, e)                           \
3858   ((e > b) \
3859    && ((size_t) ((e) - (b))) >= STRSIZE (literal)   \
3860    && 0 == strncasecmp (b, literal, STRSIZE (literal))  \
3861    && ((size_t) ((e) - (b)) == STRSIZE (literal)          \
3862        || c_isspace (b[STRSIZE (literal)])))
3863
3864 static bool
3865 known_authentication_scheme_p (const char *hdrbeg, const char *hdrend)
3866 {
3867   return STARTS ("Basic", hdrbeg, hdrend)
3868 #ifdef ENABLE_DIGEST
3869     || STARTS ("Digest", hdrbeg, hdrend)
3870 #endif
3871 #ifdef ENABLE_NTLM
3872     || STARTS ("NTLM", hdrbeg, hdrend)
3873 #endif
3874     ;
3875 }
3876
3877 #undef STARTS
3878
3879 /* Create the HTTP authorization request header.  When the
3880    `WWW-Authenticate' response header is seen, according to the
3881    authorization scheme specified in that header (`Basic' and `Digest'
3882    are supported by the current implementation), produce an
3883    appropriate HTTP authorization request header.  */
3884 static char *
3885 create_authorization_line (const char *au, const char *user,
3886                            const char *passwd, const char *method,
3887                            const char *path, bool *finished)
3888 {
3889   /* We are called only with known schemes, so we can dispatch on the
3890      first letter. */
3891   switch (c_toupper (*au))
3892     {
3893     case 'B':                   /* Basic */
3894       *finished = true;
3895       return basic_authentication_encode (user, passwd);
3896 #ifdef ENABLE_DIGEST
3897     case 'D':                   /* Digest */
3898       *finished = true;
3899       return digest_authentication_encode (au, user, passwd, method, path);
3900 #endif
3901 #ifdef ENABLE_NTLM
3902     case 'N':                   /* NTLM */
3903       if (!ntlm_input (&pconn.ntlm, au))
3904         {
3905           *finished = true;
3906           return NULL;
3907         }
3908       return ntlm_output (&pconn.ntlm, user, passwd, finished);
3909 #endif
3910     default:
3911       /* We shouldn't get here -- this function should be only called
3912          with values approved by known_authentication_scheme_p.  */
3913       abort ();
3914     }
3915 }
3916 \f
3917 static void
3918 load_cookies (void)
3919 {
3920   if (!wget_cookie_jar)
3921     wget_cookie_jar = cookie_jar_new ();
3922   if (opt.cookies_input && !cookies_loaded_p)
3923     {
3924       cookie_jar_load (wget_cookie_jar, opt.cookies_input);
3925       cookies_loaded_p = true;
3926     }
3927 }
3928
3929 void
3930 save_cookies (void)
3931 {
3932   if (wget_cookie_jar)
3933     cookie_jar_save (wget_cookie_jar, opt.cookies_output);
3934 }
3935
3936 void
3937 http_cleanup (void)
3938 {
3939   xfree_null (pconn.host);
3940   if (wget_cookie_jar)
3941     cookie_jar_delete (wget_cookie_jar);
3942 }
3943
3944 void
3945 ensure_extension (struct http_stat *hs, const char *ext, int *dt)
3946 {
3947   char *last_period_in_local_filename = strrchr (hs->local_file, '.');
3948   char shortext[8];
3949   int len = strlen (ext);
3950   if (len == 5)
3951     {
3952       strncpy (shortext, ext, len - 1);
3953       shortext[len - 1] = '\0';
3954     }
3955
3956   if (last_period_in_local_filename == NULL
3957       || !(0 == strcasecmp (last_period_in_local_filename, shortext)
3958            || 0 == strcasecmp (last_period_in_local_filename, ext)))
3959     {
3960       int local_filename_len = strlen (hs->local_file);
3961       /* Resize the local file, allowing for ".html" preceded by
3962          optional ".NUMBER".  */
3963       hs->local_file = xrealloc (hs->local_file,
3964                                  local_filename_len + 24 + len);
3965       strcpy (hs->local_file + local_filename_len, ext);
3966       /* If clobbering is not allowed and the file, as named,
3967          exists, tack on ".NUMBER.html" instead. */
3968       if (!ALLOW_CLOBBER && file_exists_p (hs->local_file))
3969         {
3970           int ext_num = 1;
3971           do
3972             sprintf (hs->local_file + local_filename_len,
3973                      ".%d%s", ext_num++, ext);
3974           while (file_exists_p (hs->local_file));
3975         }
3976       *dt |= ADDED_HTML_EXTENSION;
3977     }
3978 }
3979
3980
3981 #ifdef TESTING
3982
3983 const char *
3984 test_parse_content_disposition()
3985 {
3986   int i;
3987   struct {
3988     char *hdrval;
3989     char *filename;
3990     bool result;
3991   } test_array[] = {
3992     { "filename=\"file.ext\"", "file.ext", true },
3993     { "attachment; filename=\"file.ext\"", "file.ext", true },
3994     { "attachment; filename=\"file.ext\"; dummy", "file.ext", true },
3995     { "attachment", NULL, false },
3996     { "attachement; filename*=UTF-8'en-US'hello.txt", "hello.txt", true },
3997     { "attachement; filename*0=\"hello\"; filename*1=\"world.txt\"", "helloworld.txt", true },
3998   };
3999
4000   for (i = 0; i < sizeof(test_array)/sizeof(test_array[0]); ++i)
4001     {
4002       char *filename;
4003       bool res;
4004
4005       res = parse_content_disposition (test_array[i].hdrval, &filename);
4006
4007       mu_assert ("test_parse_content_disposition: wrong result",
4008                  res == test_array[i].result
4009                  && (res == false
4010                      || 0 == strcmp (test_array[i].filename, filename)));
4011     }
4012
4013   return NULL;
4014 }
4015
4016 #endif /* TESTING */
4017
4018 /*
4019  * vim: et sts=2 sw=2 cino+={s
4020  */
4021