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