]> sjero.net Git - wget/blob - src/retr.c
[svn] Minor improvements to fd_read_hunk.
[wget] / src / retr.c
1 /* File retrieval.
2    Copyright (C) 1995, 1996, 1997, 1998, 2000, 2001 Free Software Foundation, Inc.
3
4 This file is part of GNU Wget.
5
6 GNU Wget is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or (at
9 your option) any later version.
10
11 GNU Wget is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with Wget; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19
20 In addition, as a special exception, the Free Software Foundation
21 gives permission to link the code of its release of Wget with the
22 OpenSSL project's "OpenSSL" library (or with modified versions of it
23 that use the same license as the "OpenSSL" library), and distribute
24 the linked executables.  You must obey the GNU General Public License
25 in all respects for all of the code used other than "OpenSSL".  If you
26 modify this file, you may extend this exception to your version of the
27 file, but you are not obligated to do so.  If you do not wish to do
28 so, delete this exception statement from your version.  */
29
30 #include <config.h>
31
32 #include <stdio.h>
33 #include <stdlib.h>
34 #ifdef HAVE_UNISTD_H
35 # include <unistd.h>
36 #endif /* HAVE_UNISTD_H */
37 #include <errno.h>
38 #include <string.h>
39 #include <assert.h>
40
41 #include "wget.h"
42 #include "utils.h"
43 #include "retr.h"
44 #include "progress.h"
45 #include "url.h"
46 #include "recur.h"
47 #include "ftp.h"
48 #include "http.h"
49 #include "host.h"
50 #include "connect.h"
51 #include "hash.h"
52 #include "convert.h"
53 #include "ptimer.h"
54
55 /* Total size of downloaded files.  Used to enforce quota.  */
56 SUM_SIZE_INT total_downloaded_bytes;
57
58 /* Total download time in milliseconds. */
59 double total_download_time;
60
61 /* If non-NULL, the stream to which output should be written.  This
62    stream is initialized when `-O' is used.  */
63 FILE *output_stream;
64
65 /* Whether output_document is a regular file we can manipulate,
66    i.e. not `-' or a device file. */
67 bool output_stream_regular;
68 \f
69 static struct {
70   wgint chunk_bytes;
71   double chunk_start;
72   double sleep_adjust;
73 } limit_data;
74
75 static void
76 limit_bandwidth_reset (void)
77 {
78   limit_data.chunk_bytes = 0;
79   limit_data.chunk_start = 0;
80   limit_data.sleep_adjust = 0;
81 }
82
83 /* Limit the bandwidth by pausing the download for an amount of time.
84    BYTES is the number of bytes received from the network, and TIMER
85    is the timer that started at the beginning of download.  */
86
87 static void
88 limit_bandwidth (wgint bytes, struct ptimer *timer)
89 {
90   double delta_t = ptimer_read (timer) - limit_data.chunk_start;
91   double expected;
92
93   limit_data.chunk_bytes += bytes;
94
95   /* Calculate the amount of time we expect downloading the chunk
96      should take.  If in reality it took less time, sleep to
97      compensate for the difference.  */
98   expected = 1000.0 * limit_data.chunk_bytes / opt.limit_rate;
99
100   if (expected > delta_t)
101     {
102       double slp = expected - delta_t + limit_data.sleep_adjust;
103       double t0, t1;
104       if (slp < 200)
105         {
106           DEBUGP (("deferring a %.2f ms sleep (%s/%.2f).\n",
107                    slp, number_to_static_string (limit_data.chunk_bytes),
108                    delta_t));
109           return;
110         }
111       DEBUGP (("\nsleeping %.2f ms for %s bytes, adjust %.2f ms\n",
112                slp, number_to_static_string (limit_data.chunk_bytes),
113                limit_data.sleep_adjust));
114
115       t0 = ptimer_read (timer);
116       xsleep (slp / 1000);
117       t1 = ptimer_measure (timer);
118
119       /* Due to scheduling, we probably slept slightly longer (or
120          shorter) than desired.  Calculate the difference between the
121          desired and the actual sleep, and adjust the next sleep by
122          that amount.  */
123       limit_data.sleep_adjust = slp - (t1 - t0);
124       /* If sleep_adjust is very large, it's likely due to suspension
125          and not clock inaccuracy.  Don't enforce those.  */
126       if (limit_data.sleep_adjust > 500)
127         limit_data.sleep_adjust = 500;
128       else if (limit_data.sleep_adjust < -500)
129         limit_data.sleep_adjust = -500;
130     }
131
132   limit_data.chunk_bytes = 0;
133   limit_data.chunk_start = ptimer_read (timer);
134 }
135
136 #ifndef MIN
137 # define MIN(i, j) ((i) <= (j) ? (i) : (j))
138 #endif
139
140 /* Write data in BUF to OUT.  However, if *SKIP is non-zero, skip that
141    amount of data and decrease SKIP.  Increment *TOTAL by the amount
142    of data written.  */
143
144 static int
145 write_data (FILE *out, const char *buf, int bufsize, wgint *skip,
146             wgint *written)
147 {
148   if (!out)
149     return 1;
150   if (*skip > bufsize)
151     {
152       *skip -= bufsize;
153       return 1;
154     }
155   if (*skip)
156     {
157       buf += *skip;
158       bufsize -= *skip;
159       *skip = 0;
160       if (bufsize == 0)
161         return 1;
162     }
163
164   fwrite (buf, 1, bufsize, out);
165   *written += bufsize;
166
167   /* Immediately flush the downloaded data.  This should not hinder
168      performance: fast downloads will arrive in large 16K chunks
169      (which stdio would write out immediately anyway), and slow
170      downloads wouldn't be limited by disk speed.  */
171   fflush (out);
172   return !ferror (out);
173 }
174
175 /* Read the contents of file descriptor FD until it the connection
176    terminates or a read error occurs.  The data is read in portions of
177    up to 16K and written to OUT as it arrives.  If opt.verbose is set,
178    the progress is shown.
179
180    TOREAD is the amount of data expected to arrive, normally only used
181    by the progress gauge.
182
183    STARTPOS is the position from which the download starts, used by
184    the progress gauge.  If QTYREAD is non-NULL, the value it points to
185    is incremented by the amount of data read from the network.  If
186    QTYWRITTEN is non-NULL, the value it points to is incremented by
187    the amount of data written to disk.  The time it took to download
188    the data (in milliseconds) is stored to ELAPSED.
189
190    The function exits and returns the amount of data read.  In case of
191    error while reading data, -1 is returned.  In case of error while
192    writing data, -2 is returned.  */
193
194 int
195 fd_read_body (int fd, FILE *out, wgint toread, wgint startpos,
196               wgint *qtyread, wgint *qtywritten, double *elapsed, int flags)
197 {
198   int ret = 0;
199
200   static char dlbuf[16384];
201   int dlbufsize = sizeof (dlbuf);
202
203   struct ptimer *timer = NULL;
204   double last_successful_read_tm = 0;
205
206   /* The progress gauge, set according to the user preferences. */
207   void *progress = NULL;
208
209   /* Non-zero if the progress gauge is interactive, i.e. if it can
210      continually update the display.  When true, smaller timeout
211      values are used so that the gauge can update the display when
212      data arrives slowly. */
213   bool progress_interactive = false;
214
215   bool exact = !!(flags & rb_read_exactly);
216   wgint skip = 0;
217
218   /* How much data we've read/written.  */
219   wgint sum_read = 0;
220   wgint sum_written = 0;
221
222   if (flags & rb_skip_startpos)
223     skip = startpos;
224
225   if (opt.verbose)
226     {
227       /* If we're skipping STARTPOS bytes, pass 0 as the INITIAL
228          argument to progress_create because the indicator doesn't
229          (yet) know about "skipping" data.  */
230       progress = progress_create (skip ? 0 : startpos, startpos + toread);
231       progress_interactive = progress_interactive_p (progress);
232     }
233
234   if (opt.limit_rate)
235     limit_bandwidth_reset ();
236
237   /* A timer is needed for tracking progress, for throttling, and for
238      tracking elapsed time.  If either of these are requested, start
239      the timer.  */
240   if (progress || opt.limit_rate || elapsed)
241     {
242       timer = ptimer_new ();
243       last_successful_read_tm = 0;
244     }
245
246   /* Use a smaller buffer for low requested bandwidths.  For example,
247      with --limit-rate=2k, it doesn't make sense to slurp in 16K of
248      data and then sleep for 8s.  With buffer size equal to the limit,
249      we never have to sleep for more than one second.  */
250   if (opt.limit_rate && opt.limit_rate < dlbufsize)
251     dlbufsize = opt.limit_rate;
252
253   /* Read from FD while there is data to read.  Normally toread==0
254      means that it is unknown how much data is to arrive.  However, if
255      EXACT is set, then toread==0 means what it says: that no data
256      should be read.  */
257   while (!exact || (sum_read < toread))
258     {
259       int rdsize = exact ? MIN (toread - sum_read, dlbufsize) : dlbufsize;
260       double tmout = opt.read_timeout;
261       if (progress_interactive)
262         {
263           /* For interactive progress gauges, always specify a ~1s
264              timeout, so that the gauge can be updated regularly even
265              when the data arrives very slowly or stalls.  */
266           tmout = 0.95;
267           if (opt.read_timeout)
268             {
269               double waittm;
270               waittm = (ptimer_read (timer) - last_successful_read_tm) / 1000;
271               if (waittm + tmout > opt.read_timeout)
272                 {
273                   /* Don't let total idle time exceed read timeout. */
274                   tmout = opt.read_timeout - waittm;
275                   if (tmout < 0)
276                     {
277                       /* We've already exceeded the timeout. */
278                       ret = -1, errno = ETIMEDOUT;
279                       break;
280                     }
281                 }
282             }
283         }
284       ret = fd_read (fd, dlbuf, rdsize, tmout);
285
286       if (progress_interactive && ret < 0 && errno == ETIMEDOUT)
287         ret = 0;                /* interactive timeout, handled above */
288       else if (ret <= 0)
289         break;                  /* EOF or read error */
290
291       if (progress || opt.limit_rate)
292         {
293           ptimer_measure (timer);
294           if (ret > 0)
295             last_successful_read_tm = ptimer_read (timer);
296         }
297
298       if (ret > 0)
299         {
300           sum_read += ret;
301           if (!write_data (out, dlbuf, ret, &skip, &sum_written))
302             {
303               ret = -2;
304               goto out;
305             }
306         }
307
308       if (opt.limit_rate)
309         limit_bandwidth (ret, timer);
310
311       if (progress)
312         progress_update (progress, ret, ptimer_read (timer));
313 #ifdef WINDOWS
314       if (toread > 0 && !opt.quiet)
315         ws_percenttitle (100.0 *
316                          (startpos + sum_read) / (startpos + toread));
317 #endif
318     }
319   if (ret < -1)
320     ret = -1;
321
322  out:
323   if (progress)
324     progress_finish (progress, ptimer_read (timer));
325
326   if (elapsed)
327     *elapsed = ptimer_read (timer);
328   if (timer)
329     ptimer_destroy (timer);
330
331   if (qtyread)
332     *qtyread += sum_read;
333   if (qtywritten)
334     *qtywritten += sum_written;
335
336   return ret;
337 }
338 \f
339 /* Read a hunk of data from FD, up until a terminator.  The hunk is
340    limited by whatever the TERMINATOR callback chooses as its
341    terminator.  For example, if terminator stops at newline, the hunk
342    will consist of a line of data; if terminator stops at two
343    newlines, it can be used to read the head of an HTTP response.
344    Upon determining the boundary, the function returns the data (up to
345    the terminator) in malloc-allocated storage.
346
347    In case of read error, NULL is returned.  In case of EOF and no
348    data read, NULL is returned and errno set to 0.  In case of having
349    read some data, but encountering EOF before seeing the terminator,
350    the data that has been read is returned, but it will (obviously)
351    not contain the terminator.
352
353    The TERMINATOR function is called with three arguments: the
354    beginning of the data read so far, the beginning of the current
355    block of peeked-at data, and the length of the current block.
356    Depending on its needs, the function is free to choose whether to
357    analyze all data or just the newly arrived data.  If TERMINATOR
358    returns NULL, it means that the terminator has not been seen.
359    Otherwise it should return a pointer to the charactre immediately
360    following the terminator.
361
362    The idea is to be able to read a line of input, or otherwise a hunk
363    of text, such as the head of an HTTP request, without crossing the
364    boundary, so that the next call to fd_read etc. reads the data
365    after the hunk.  To achieve that, this function does the following:
366
367    1. Peek at incoming data.
368
369    2. Determine whether the peeked data, along with the previously
370       read data, includes the terminator.
371
372       2a. If yes, read the data until the end of the terminator, and
373           exit.
374
375       2b. If no, read the peeked data and goto 1.
376
377    The function is careful to assume as little as possible about the
378    implementation of peeking.  For example, every peek is followed by
379    a read.  If the read returns a different amount of data, the
380    process is retried until all data arrives safely.
381
382    SIZEHINT is the buffer size sufficient to hold all the data in the
383    typical case (it is used as the initial buffer size).  MAXSIZE is
384    the maximum amount of memory this function is allowed to allocate,
385    or 0 if no upper limit is to be enforced.
386
387    This function should be used as a building block for other
388    functions -- see fd_read_line as a simple example.  */
389
390 char *
391 fd_read_hunk (int fd, hunk_terminator_t terminator, long sizehint, long maxsize)
392 {
393   long bufsize = sizehint;
394   char *hunk = xmalloc (bufsize);
395   int tail = 0;                 /* tail position in HUNK */
396
397   assert (maxsize >= bufsize);
398
399   while (1)
400     {
401       const char *end;
402       int pklen, rdlen, remain;
403
404       /* First, peek at the available data. */
405
406       pklen = fd_peek (fd, hunk + tail, bufsize - 1 - tail, -1);
407       if (pklen < 0)
408         {
409           xfree (hunk);
410           return NULL;
411         }
412       end = terminator (hunk, hunk + tail, pklen);
413       if (end)
414         {
415           /* The data contains the terminator: we'll drain the data up
416              to the end of the terminator.  */
417           remain = end - (hunk + tail);
418           assert (remain >= 0);
419           if (remain == 0)
420             {
421               /* No more data needs to be read. */
422               hunk[tail] = '\0';
423               return hunk;
424             }
425           if (bufsize - 1 < tail + remain)
426             {
427               bufsize = tail + remain + 1;
428               hunk = xrealloc (hunk, bufsize);
429             }
430         }
431       else
432         /* No terminator: simply read the data we know is (or should
433            be) available.  */
434         remain = pklen;
435
436       /* Now, read the data.  Note that we make no assumptions about
437          how much data we'll get.  (Some TCP stacks are notorious for
438          read returning less data than the previous MSG_PEEK.)  */
439
440       rdlen = fd_read (fd, hunk + tail, remain, 0);
441       if (rdlen < 0)
442         {
443           xfree_null (hunk);
444           return NULL;
445         }
446       tail += rdlen;
447       hunk[tail] = '\0';
448
449       if (rdlen == 0)
450         {
451           if (tail == 0)
452             {
453               /* EOF without anything having been read */
454               xfree (hunk);
455               errno = 0;
456               return NULL;
457             }
458           else
459             /* EOF seen: return the data we've read. */
460             return hunk;
461         }
462       if (end && rdlen == remain)
463         /* The terminator was seen and the remaining data drained --
464            we got what we came for.  */
465         return hunk;
466
467       /* Keep looping until all the data arrives. */
468
469       if (tail == bufsize - 1)
470         {
471           /* Double the buffer size, but refuse to allocate more than
472              MAXSIZE bytes.  */
473           if (maxsize && bufsize >= maxsize)
474             {
475               xfree (hunk);
476               errno = ENOMEM;
477               return NULL;
478             }
479           bufsize <<= 1;
480           if (maxsize && bufsize > maxsize)
481             bufsize = maxsize;
482           hunk = xrealloc (hunk, bufsize);
483         }
484     }
485 }
486
487 static const char *
488 line_terminator (const char *start, const char *peeked, int peeklen)
489 {
490   const char *p = memchr (peeked, '\n', peeklen);
491   if (p)
492     /* p+1 because the line must include '\n' */
493     return p + 1;
494   return NULL;
495 }
496
497 /* The maximum size of the single line we agree to accept.  This is
498    not meant to impose an arbitrary limit, but to protect the user
499    from Wget slurping up available memory upon encountering malicious
500    or buggy server output.  Define it to 0 to remove the limit.  */
501 #define FD_READ_LINE_MAX 4096
502
503 /* Read one line from FD and return it.  The line is allocated using
504    malloc, but is never larger than FD_READ_LINE_MAX.
505
506    If an error occurs, or if no data can be read, NULL is returned.
507    In the former case errno indicates the error condition, and in the
508    latter case, errno is NULL.  */
509
510 char *
511 fd_read_line (int fd)
512 {
513   return fd_read_hunk (fd, line_terminator, 128, FD_READ_LINE_MAX);
514 }
515 \f
516 /* Return a printed representation of the download rate, along with
517    the units appropriate for the download speed.  */
518
519 const char *
520 retr_rate (wgint bytes, double msecs)
521 {
522   static char res[20];
523   static const char *rate_names[] = {"B/s", "KB/s", "MB/s", "GB/s" };
524   int units = 0;
525
526   double dlrate = calc_rate (bytes, msecs, &units);
527   sprintf (res, "%.2f %s", dlrate, rate_names[units]);
528
529   return res;
530 }
531
532 /* Calculate the download rate and trim it as appropriate for the
533    speed.  Appropriate means that if rate is greater than 1K/s,
534    kilobytes are used, and if rate is greater than 1MB/s, megabytes
535    are used.
536
537    UNITS is zero for B/s, one for KB/s, two for MB/s, and three for
538    GB/s.  */
539 double
540 calc_rate (wgint bytes, double msecs, int *units)
541 {
542   double dlrate;
543
544   assert (msecs >= 0);
545   assert (bytes >= 0);
546
547   if (msecs == 0)
548     /* If elapsed time is exactly zero, it means we're under the
549        resolution of the timer.  This can easily happen on systems
550        that use time() for the timer.  Since the interval lies between
551        0 and the timer's resolution, assume half the resolution.  */
552     msecs = ptimer_resolution () / 2.0;
553
554   dlrate = 1000.0 * bytes / msecs;
555   if (dlrate < 1024.0)
556     *units = 0;
557   else if (dlrate < 1024.0 * 1024.0)
558     *units = 1, dlrate /= 1024.0;
559   else if (dlrate < 1024.0 * 1024.0 * 1024.0)
560     *units = 2, dlrate /= (1024.0 * 1024.0);
561   else
562     /* Maybe someone will need this, one day. */
563     *units = 3, dlrate /= (1024.0 * 1024.0 * 1024.0);
564
565   return dlrate;
566 }
567 \f
568 /* Maximum number of allowed redirections.  20 was chosen as a
569    "reasonable" value, which is low enough to not cause havoc, yet
570    high enough to guarantee that normal retrievals will not be hurt by
571    the check.  */
572
573 #define MAX_REDIRECTIONS 20
574
575 #define SUSPEND_POST_DATA do {                  \
576   post_data_suspended = true;                   \
577   saved_post_data = opt.post_data;              \
578   saved_post_file_name = opt.post_file_name;    \
579   opt.post_data = NULL;                         \
580   opt.post_file_name = NULL;                    \
581 } while (0)
582
583 #define RESTORE_POST_DATA do {                          \
584   if (post_data_suspended)                              \
585     {                                                   \
586       opt.post_data = saved_post_data;                  \
587       opt.post_file_name = saved_post_file_name;        \
588       post_data_suspended = false;                      \
589     }                                                   \
590 } while (0)
591
592 static char *getproxy (struct url *);
593
594 /* Retrieve the given URL.  Decides which loop to call -- HTTP, FTP,
595    FTP, proxy, etc.  */
596
597 /* #### This function should be rewritten so it doesn't return from
598    multiple points. */
599
600 uerr_t
601 retrieve_url (const char *origurl, char **file, char **newloc,
602               const char *refurl, int *dt)
603 {
604   uerr_t result;
605   char *url;
606   bool location_changed;
607   int dummy;
608   char *mynewloc, *proxy;
609   struct url *u, *proxy_url;
610   int up_error_code;            /* url parse error code */
611   char *local_file;
612   int redirection_count = 0;
613
614   bool post_data_suspended = false;
615   char *saved_post_data = NULL;
616   char *saved_post_file_name = NULL;
617
618   /* If dt is NULL, use local storage.  */
619   if (!dt)
620     {
621       dt = &dummy;
622       dummy = 0;
623     }
624   url = xstrdup (origurl);
625   if (newloc)
626     *newloc = NULL;
627   if (file)
628     *file = NULL;
629
630   u = url_parse (url, &up_error_code);
631   if (!u)
632     {
633       logprintf (LOG_NOTQUIET, "%s: %s.\n", url, url_error (up_error_code));
634       xfree (url);
635       return URLERROR;
636     }
637
638   if (!refurl)
639     refurl = opt.referer;
640
641  redirected:
642
643   result = NOCONERROR;
644   mynewloc = NULL;
645   local_file = NULL;
646   proxy_url = NULL;
647
648   proxy = getproxy (u);
649   if (proxy)
650     {
651       /* Parse the proxy URL.  */
652       proxy_url = url_parse (proxy, &up_error_code);
653       if (!proxy_url)
654         {
655           logprintf (LOG_NOTQUIET, _("Error parsing proxy URL %s: %s.\n"),
656                      proxy, url_error (up_error_code));
657           xfree (url);
658           RESTORE_POST_DATA;
659           return PROXERR;
660         }
661       if (proxy_url->scheme != SCHEME_HTTP && proxy_url->scheme != u->scheme)
662         {
663           logprintf (LOG_NOTQUIET, _("Error in proxy URL %s: Must be HTTP.\n"), proxy);
664           url_free (proxy_url);
665           xfree (url);
666           RESTORE_POST_DATA;
667           return PROXERR;
668         }
669     }
670
671   if (u->scheme == SCHEME_HTTP
672 #ifdef HAVE_SSL
673       || u->scheme == SCHEME_HTTPS
674 #endif
675       || (proxy_url && proxy_url->scheme == SCHEME_HTTP))
676     {
677       result = http_loop (u, &mynewloc, &local_file, refurl, dt, proxy_url);
678     }
679   else if (u->scheme == SCHEME_FTP)
680     {
681       /* If this is a redirection, temporarily turn off opt.ftp_glob
682          and opt.recursive, both being undesirable when following
683          redirects.  */
684       bool oldrec = opt.recursive, oldglob = opt.ftp_glob;
685       if (redirection_count)
686         opt.recursive = opt.ftp_glob = false;
687
688       result = ftp_loop (u, dt, proxy_url);
689       opt.recursive = oldrec;
690       opt.ftp_glob = oldglob;
691
692       /* There is a possibility of having HTTP being redirected to
693          FTP.  In these cases we must decide whether the text is HTML
694          according to the suffix.  The HTML suffixes are `.html',
695          `.htm' and a few others, case-insensitive.  */
696       if (redirection_count && local_file && u->scheme == SCHEME_FTP)
697         {
698           if (has_html_suffix_p (local_file))
699             *dt |= TEXTHTML;
700         }
701     }
702
703   if (proxy_url)
704     {
705       url_free (proxy_url);
706       proxy_url = NULL;
707     }
708
709   location_changed = (result == NEWLOCATION);
710   if (location_changed)
711     {
712       char *construced_newloc;
713       struct url *newloc_parsed;
714
715       assert (mynewloc != NULL);
716
717       if (local_file)
718         xfree (local_file);
719
720       /* The HTTP specs only allow absolute URLs to appear in
721          redirects, but a ton of boneheaded webservers and CGIs out
722          there break the rules and use relative URLs, and popular
723          browsers are lenient about this, so wget should be too. */
724       construced_newloc = uri_merge (url, mynewloc);
725       xfree (mynewloc);
726       mynewloc = construced_newloc;
727
728       /* Now, see if this new location makes sense. */
729       newloc_parsed = url_parse (mynewloc, &up_error_code);
730       if (!newloc_parsed)
731         {
732           logprintf (LOG_NOTQUIET, "%s: %s.\n", escnonprint_uri (mynewloc),
733                      url_error (up_error_code));
734           url_free (u);
735           xfree (url);
736           xfree (mynewloc);
737           RESTORE_POST_DATA;
738           return result;
739         }
740
741       /* Now mynewloc will become newloc_parsed->url, because if the
742          Location contained relative paths like .././something, we
743          don't want that propagating as url.  */
744       xfree (mynewloc);
745       mynewloc = xstrdup (newloc_parsed->url);
746
747       /* Check for max. number of redirections.  */
748       if (++redirection_count > MAX_REDIRECTIONS)
749         {
750           logprintf (LOG_NOTQUIET, _("%d redirections exceeded.\n"),
751                      MAX_REDIRECTIONS);
752           url_free (newloc_parsed);
753           url_free (u);
754           xfree (url);
755           xfree (mynewloc);
756           RESTORE_POST_DATA;
757           return WRONGCODE;
758         }
759
760       xfree (url);
761       url = mynewloc;
762       url_free (u);
763       u = newloc_parsed;
764
765       /* If we're being redirected from POST, we don't want to POST
766          again.  Many requests answer POST with a redirection to an
767          index page; that redirection is clearly a GET.  We "suspend"
768          POST data for the duration of the redirections, and restore
769          it when we're done. */
770       if (!post_data_suspended)
771         SUSPEND_POST_DATA;
772
773       goto redirected;
774     }
775
776   if (local_file)
777     {
778       if (*dt & RETROKF)
779         {
780           register_download (u->url, local_file);
781           if (redirection_count && 0 != strcmp (origurl, u->url))
782             register_redirection (origurl, u->url);
783           if (*dt & TEXTHTML)
784             register_html (u->url, local_file);
785         }
786     }
787
788   if (file)
789     *file = local_file ? local_file : NULL;
790   else
791     xfree_null (local_file);
792
793   url_free (u);
794
795   if (redirection_count)
796     {
797       if (newloc)
798         *newloc = url;
799       else
800         xfree (url);
801     }
802   else
803     {
804       if (newloc)
805         *newloc = NULL;
806       xfree (url);
807     }
808
809   RESTORE_POST_DATA;
810
811   return result;
812 }
813
814 /* Find the URLs in the file and call retrieve_url() for each of them.
815    If HTML is true, treat the file as HTML, and construct the URLs
816    accordingly.
817
818    If opt.recursive is set, call retrieve_tree() for each file.  */
819
820 uerr_t
821 retrieve_from_file (const char *file, bool html, int *count)
822 {
823   uerr_t status;
824   struct urlpos *url_list, *cur_url;
825
826   url_list = (html ? get_urls_html (file, NULL, NULL)
827               : get_urls_file (file));
828   status = RETROK;             /* Suppose everything is OK.  */
829   *count = 0;                  /* Reset the URL count.  */
830
831   for (cur_url = url_list; cur_url; cur_url = cur_url->next, ++*count)
832     {
833       char *filename = NULL, *new_file = NULL;
834       int dt;
835
836       if (cur_url->ignore_when_downloading)
837         continue;
838
839       if (opt.quota && total_downloaded_bytes > opt.quota)
840         {
841           status = QUOTEXC;
842           break;
843         }
844       if ((opt.recursive || opt.page_requisites)
845           && cur_url->url->scheme != SCHEME_FTP)
846         status = retrieve_tree (cur_url->url->url);
847       else
848         status = retrieve_url (cur_url->url->url, &filename, &new_file, NULL, &dt);
849
850       if (filename && opt.delete_after && file_exists_p (filename))
851         {
852           DEBUGP (("\
853 Removing file due to --delete-after in retrieve_from_file():\n"));
854           logprintf (LOG_VERBOSE, _("Removing %s.\n"), filename);
855           if (unlink (filename))
856             logprintf (LOG_NOTQUIET, "unlink: %s\n", strerror (errno));
857           dt &= ~RETROKF;
858         }
859
860       xfree_null (new_file);
861       xfree_null (filename);
862     }
863
864   /* Free the linked list of URL-s.  */
865   free_urlpos (url_list);
866
867   return status;
868 }
869
870 /* Print `giving up', or `retrying', depending on the impending
871    action.  N1 and N2 are the attempt number and the attempt limit.  */
872 void
873 printwhat (int n1, int n2)
874 {
875   logputs (LOG_VERBOSE, (n1 == n2) ? _("Giving up.\n\n") : _("Retrying.\n\n"));
876 }
877
878 /* If opt.wait or opt.waitretry are specified, and if certain
879    conditions are met, sleep the appropriate number of seconds.  See
880    the documentation of --wait and --waitretry for more information.
881
882    COUNT is the count of current retrieval, beginning with 1. */
883
884 void
885 sleep_between_retrievals (int count)
886 {
887   static bool first_retrieval = true;
888
889   if (first_retrieval)
890     {
891       /* Don't sleep before the very first retrieval. */
892       first_retrieval = false;
893       return;
894     }
895
896   if (opt.waitretry && count > 1)
897     {
898       /* If opt.waitretry is specified and this is a retry, wait for
899          COUNT-1 number of seconds, or for opt.waitretry seconds.  */
900       if (count <= opt.waitretry)
901         xsleep (count - 1);
902       else
903         xsleep (opt.waitretry);
904     }
905   else if (opt.wait)
906     {
907       if (!opt.random_wait || count > 1)
908         /* If random-wait is not specified, or if we are sleeping
909            between retries of the same download, sleep the fixed
910            interval.  */
911         xsleep (opt.wait);
912       else
913         {
914           /* Sleep a random amount of time averaging in opt.wait
915              seconds.  The sleeping amount ranges from 0 to
916              opt.wait*2, inclusive.  */
917           double waitsecs = 2 * opt.wait * random_float ();
918           DEBUGP (("sleep_between_retrievals: avg=%f,sleep=%f\n",
919                    opt.wait, waitsecs));
920           xsleep (waitsecs);
921         }
922     }
923 }
924
925 /* Free the linked list of urlpos.  */
926 void
927 free_urlpos (struct urlpos *l)
928 {
929   while (l)
930     {
931       struct urlpos *next = l->next;
932       if (l->url)
933         url_free (l->url);
934       xfree_null (l->local_name);
935       xfree (l);
936       l = next;
937     }
938 }
939
940 /* Rotate FNAME opt.backups times */
941 void
942 rotate_backups(const char *fname)
943 {
944   int maxlen = strlen (fname) + 1 + numdigit (opt.backups) + 1;
945   char *from = (char *)alloca (maxlen);
946   char *to = (char *)alloca (maxlen);
947   struct_stat sb;
948   int i;
949
950   if (stat (fname, &sb) == 0)
951     if (S_ISREG (sb.st_mode) == 0)
952       return;
953
954   for (i = opt.backups; i > 1; i--)
955     {
956       sprintf (from, "%s.%d", fname, i - 1);
957       sprintf (to, "%s.%d", fname, i);
958       rename (from, to);
959     }
960
961   sprintf (to, "%s.%d", fname, 1);
962   rename(fname, to);
963 }
964
965 static bool no_proxy_match (const char *, const char **);
966
967 /* Return the URL of the proxy appropriate for url U.  */
968
969 static char *
970 getproxy (struct url *u)
971 {
972   char *proxy = NULL;
973   char *rewritten_url;
974   static char rewritten_storage[1024];
975
976   if (!opt.use_proxy)
977     return NULL;
978   if (!no_proxy_match (u->host, (const char **)opt.no_proxy))
979     return NULL;
980
981   switch (u->scheme)
982     {
983     case SCHEME_HTTP:
984       proxy = opt.http_proxy ? opt.http_proxy : getenv ("http_proxy");
985       break;
986 #ifdef HAVE_SSL
987     case SCHEME_HTTPS:
988       proxy = opt.https_proxy ? opt.https_proxy : getenv ("https_proxy");
989       break;
990 #endif
991     case SCHEME_FTP:
992       proxy = opt.ftp_proxy ? opt.ftp_proxy : getenv ("ftp_proxy");
993       break;
994     case SCHEME_INVALID:
995       break;
996     }
997   if (!proxy || !*proxy)
998     return NULL;
999
1000   /* Handle shorthands.  `rewritten_storage' is a kludge to allow
1001      getproxy() to return static storage. */
1002   rewritten_url = rewrite_shorthand_url (proxy);
1003   if (rewritten_url)
1004     {
1005       strncpy (rewritten_storage, rewritten_url, sizeof (rewritten_storage));
1006       rewritten_storage[sizeof (rewritten_storage) - 1] = '\0';
1007       proxy = rewritten_storage;
1008     }
1009
1010   return proxy;
1011 }
1012
1013 /* Should a host be accessed through proxy, concerning no_proxy?  */
1014 static bool
1015 no_proxy_match (const char *host, const char **no_proxy)
1016 {
1017   if (!no_proxy)
1018     return true;
1019   else
1020     return !sufmatch (no_proxy, host);
1021 }