2 Copyright (C) 1995, 1996, 1997, 2000, 2001 Free Software Foundation, Inc.
4 This file is part of GNU Wget.
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.
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.
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. */
29 #include <sys/types.h>
47 #define DOTP(x) ((*(x) == '.') && (!*(x + 1)))
49 #define DDOTP(x) ((*(x) == '.') && (*(x + 1) == '.') && (!*(x + 2)))
58 /* Supported schemes: */
59 static struct scheme_data supported_schemes[] =
61 { "http://", DEFAULT_HTTP_PORT, 1 },
63 { "https://", DEFAULT_HTTPS_PORT, 1 },
65 { "ftp://", DEFAULT_FTP_PORT, 1 },
71 /* Forward declarations: */
73 static char *construct_relative PARAMS ((const char *, const char *));
74 static int path_simplify PARAMS ((char *));
78 /* Support for encoding and decoding of URL strings. We determine
79 whether a character is unsafe through static table lookup. This
80 code assumes ASCII character set and 8-bit chars. */
87 #define R urlchr_reserved
88 #define U urlchr_unsafe
91 #define urlchr_test(c, mask) (urlchr_table[(unsigned char)(c)] & (mask))
93 /* rfc1738 reserved chars, preserved from encoding. */
95 #define RESERVED_CHAR(c) urlchr_test(c, urlchr_reserved)
97 /* rfc1738 unsafe chars, plus some more. */
99 #define UNSAFE_CHAR(c) urlchr_test(c, urlchr_unsafe)
101 const static unsigned char urlchr_table[256] =
103 U, U, U, U, U, U, U, U, /* NUL SOH STX ETX EOT ENQ ACK BEL */
104 U, U, U, U, U, U, U, U, /* BS HT LF VT FF CR SO SI */
105 U, U, U, U, U, U, U, U, /* DLE DC1 DC2 DC3 DC4 NAK SYN ETB */
106 U, U, U, U, U, U, U, U, /* CAN EM SUB ESC FS GS RS US */
107 U, 0, U, RU, 0, U, R, 0, /* SP ! " # $ % & ' */
108 0, 0, 0, R, 0, 0, 0, R, /* ( ) * + , - . / */
109 0, 0, 0, 0, 0, 0, 0, 0, /* 0 1 2 3 4 5 6 7 */
110 0, 0, RU, R, U, R, U, R, /* 8 9 : ; < = > ? */
111 RU, 0, 0, 0, 0, 0, 0, 0, /* @ A B C D E F G */
112 0, 0, 0, 0, 0, 0, 0, 0, /* H I J K L M N O */
113 0, 0, 0, 0, 0, 0, 0, 0, /* P Q R S T U V W */
114 0, 0, 0, RU, U, RU, U, 0, /* X Y Z [ \ ] ^ _ */
115 U, 0, 0, 0, 0, 0, 0, 0, /* ` a b c d e f g */
116 0, 0, 0, 0, 0, 0, 0, 0, /* h i j k l m n o */
117 0, 0, 0, 0, 0, 0, 0, 0, /* p q r s t u v w */
118 0, 0, 0, U, U, U, U, U, /* x y z { | } ~ DEL */
120 U, U, U, U, U, U, U, U, U, U, U, U, U, U, U, U,
121 U, U, U, U, U, U, U, U, U, U, U, U, U, U, U, U,
122 U, U, U, U, U, U, U, U, U, U, U, U, U, U, U, U,
123 U, U, U, U, U, U, U, U, U, U, U, U, U, U, U, U,
125 U, U, U, U, U, U, U, U, U, U, U, U, U, U, U, U,
126 U, U, U, U, U, U, U, U, U, U, U, U, U, U, U, U,
127 U, U, U, U, U, U, U, U, U, U, U, U, U, U, U, U,
128 U, U, U, U, U, U, U, U, U, U, U, U, U, U, U, U,
131 /* Decodes the forms %xy in a URL to the character the hexadecimal
132 code of which is xy. xy are hexadecimal digits from
133 [0123456789ABCDEF] (case-insensitive). If x or y are not
134 hex-digits or `%' precedes `\0', the sequence is inserted
138 decode_string (char *s)
140 char *t = s; /* t - tortoise */
141 char *h = s; /* h - hare */
152 /* Do nothing if '%' is not followed by two hex digits. */
153 if (!*(h + 1) || !*(h + 2)
154 || !(ISXDIGIT (*(h + 1)) && ISXDIGIT (*(h + 2))))
156 *t = (XCHAR_TO_XDIGIT (*(h + 1)) << 4) + XCHAR_TO_XDIGIT (*(h + 2));
163 /* Like encode_string, but return S if there are no unsafe chars. */
166 encode_string_maybe (const char *s)
173 for (p1 = s; *p1; p1++)
174 if (UNSAFE_CHAR (*p1))
175 addition += 2; /* Two more characters (hex digits) */
180 newlen = (p1 - s) + addition;
181 newstr = (char *)xmalloc (newlen + 1);
187 if (UNSAFE_CHAR (*p1))
189 unsigned char c = *p1++;
191 *p2++ = XDIGIT_TO_XCHAR (c >> 4);
192 *p2++ = XDIGIT_TO_XCHAR (c & 0xf);
198 assert (p2 - newstr == newlen);
203 /* Encode the unsafe characters (as determined by UNSAFE_CHAR) in a
204 given string, returning a malloc-ed %XX encoded string. */
207 encode_string (const char *s)
209 char *encoded = encode_string_maybe (s);
216 /* Encode unsafe characters in PTR to %xx. If such encoding is done,
217 the old value of PTR is freed and PTR is made to point to the newly
218 allocated storage. */
220 #define ENCODE(ptr) do { \
221 char *e_new = encode_string_maybe (ptr); \
229 enum copy_method { CM_DECODE, CM_ENCODE, CM_PASSTHROUGH };
231 /* Decide whether to encode, decode, or pass through the char at P.
232 This used to be a macro, but it got a little too convoluted. */
233 static inline enum copy_method
234 decide_copy_method (const char *p)
238 if (ISXDIGIT (*(p + 1)) && ISXDIGIT (*(p + 2)))
240 /* %xx sequence: decode it, unless it would decode to an
241 unsafe or a reserved char; in that case, leave it as
243 char preempt = (XCHAR_TO_XDIGIT (*(p + 1)) << 4) +
244 XCHAR_TO_XDIGIT (*(p + 2));
246 if (UNSAFE_CHAR (preempt) || RESERVED_CHAR (preempt))
247 return CM_PASSTHROUGH;
252 /* Garbled %.. sequence: encode `%'. */
255 else if (UNSAFE_CHAR (*p) && !RESERVED_CHAR (*p))
258 return CM_PASSTHROUGH;
261 /* Translate a %-quoting (but possibly non-conformant) input string S
262 into a %-quoting (and conformant) output string. If no characters
263 are encoded or decoded, return the same string S; otherwise, return
264 a freshly allocated string with the new contents.
266 After a URL has been run through this function, the protocols that
267 use `%' as the quote character can use the resulting string as-is,
268 while those that don't call decode_string() to get to the intended
269 data. This function is also stable: after an input string is
270 transformed the first time, all further transformations of the
271 result yield the same result string.
273 Let's discuss why this function is needed.
275 Imagine Wget is to retrieve `http://abc.xyz/abc def'. Since a raw
276 space character would mess up the HTTP request, it needs to be
279 GET /abc%20def HTTP/1.0
281 So it appears that the unsafe chars need to be quoted, as with
282 encode_string. But what if we're requested to download
283 `abc%20def'? Remember that %-encoding is valid URL syntax, so what
284 the user meant was a literal space, and he was kind enough to quote
285 it. In that case, Wget should obviously leave the `%20' as is, and
286 send the same request as above. So in this case we may not call
289 But what if the requested URI is `abc%20 def'? If we call
290 encode_string, we end up with `/abc%2520%20def', which is almost
291 certainly not intended. If we don't call encode_string, we are
292 left with the embedded space and cannot send the request. What the
293 user meant was for Wget to request `/abc%20%20def', and this is
294 where reencode_string kicks in.
296 Wget used to solve this by first decoding %-quotes, and then
297 encoding all the "unsafe" characters found in the resulting string.
298 This was wrong because it didn't preserve certain URL special
299 (reserved) characters. For instance, URI containing "a%2B+b" (0x2b
300 == '+') would get translated to "a%2B%2Bb" or "a++b" depending on
301 whether we considered `+' reserved (it is). One of these results
302 is inevitable because by the second step we would lose information
303 on whether the `+' was originally encoded or not. Both results
304 were wrong because in CGI parameters + means space, while %2B means
305 literal plus. reencode_string correctly translates the above to
306 "a%2B+b", i.e. returns the original string.
308 This function uses an algorithm proposed by Anon Sricharoenchai:
310 1. Encode all URL_UNSAFE and the "%" that are not followed by 2
313 2. Decode all "%XX" except URL_UNSAFE, URL_RESERVED (";/?:@=&") and
316 ...except that this code conflates the two steps, and decides
317 whether to encode, decode, or pass through each character in turn.
318 The function still uses two passes, but their logic is the same --
319 the first pass exists merely for the sake of allocation. Another
320 small difference is that we include `+' to URL_RESERVED.
324 "http://abc.xyz/%20%3F%%36%31%25aa% a?a=%61+a%2Ba&b=b%26c%3Dc"
326 "http://abc.xyz/%20%3F%2561%25aa%25%20a?a=a+a%2Ba&b=b%26c%3Dc"
330 "foo bar" -> "foo%20bar"
331 "foo%20bar" -> "foo%20bar"
332 "foo %20bar" -> "foo%20%20bar"
333 "foo%%20bar" -> "foo%25%20bar" (0x25 == '%')
334 "foo%25%20bar" -> "foo%25%20bar"
335 "foo%2%20bar" -> "foo%252%20bar"
336 "foo+bar" -> "foo+bar" (plus is reserved!)
337 "foo%2b+bar" -> "foo%2b+bar" */
340 reencode_string (const char *s)
346 int encode_count = 0;
347 int decode_count = 0;
349 /* First, pass through the string to see if there's anything to do,
350 and to calculate the new length. */
351 for (p1 = s; *p1; p1++)
353 switch (decide_copy_method (p1))
366 if (!encode_count && !decode_count)
367 /* The string is good as it is. */
368 return (char *)s; /* C const model sucks. */
371 /* Each encoding adds two characters (hex digits), while each
372 decoding removes two characters. */
373 newlen = oldlen + 2 * (encode_count - decode_count);
374 newstr = xmalloc (newlen + 1);
381 switch (decide_copy_method (p1))
385 unsigned char c = *p1++;
387 *p2++ = XDIGIT_TO_XCHAR (c >> 4);
388 *p2++ = XDIGIT_TO_XCHAR (c & 0xf);
392 *p2++ = ((XCHAR_TO_XDIGIT (*(p1 + 1)) << 4)
393 + (XCHAR_TO_XDIGIT (*(p1 + 2))));
394 p1 += 3; /* skip %xx */
401 assert (p2 - newstr == newlen);
405 /* Run PTR_VAR through reencode_string. If a new string is consed,
406 free PTR_VAR and make it point to the new storage. Obviously,
407 PTR_VAR needs to be an lvalue. */
409 #define REENCODE(ptr_var) do { \
410 char *rf_new = reencode_string (ptr_var); \
411 if (rf_new != ptr_var) \
418 /* Returns the scheme type if the scheme is supported, or
419 SCHEME_INVALID if not. */
421 url_scheme (const char *url)
425 for (i = 0; supported_schemes[i].leading_string; i++)
426 if (0 == strncasecmp (url, supported_schemes[i].leading_string,
427 strlen (supported_schemes[i].leading_string)))
429 if (supported_schemes[i].enabled)
430 return (enum url_scheme) i;
432 return SCHEME_INVALID;
435 return SCHEME_INVALID;
438 /* Return the number of characters needed to skip the scheme part of
439 the URL, e.g. `http://'. If no scheme is found, returns 0. */
441 url_skip_scheme (const char *url)
445 /* Skip the scheme name. We allow `-' and `+' because of `whois++',
447 while (ISALNUM (*p) || *p == '-' || *p == '+')
454 /* Skip "//" if found. */
455 if (*p == '/' && *(p + 1) == '/')
461 /* Returns 1 if the URL begins with a scheme (supported or
462 unsupported), 0 otherwise. */
464 url_has_scheme (const char *url)
467 while (ISALNUM (*p) || *p == '-' || *p == '+')
473 scheme_default_port (enum url_scheme scheme)
475 return supported_schemes[scheme].default_port;
479 scheme_disable (enum url_scheme scheme)
481 supported_schemes[scheme].enabled = 0;
484 /* Skip the username and password, if present here. The function
485 should be called *not* with the complete URL, but with the part
486 right after the scheme.
488 If no username and password are found, return 0. */
490 url_skip_uname (const char *url)
494 /* Look for '@' that comes before '/' or '?'. */
495 p = (const char *)strpbrk (url, "/?@");
503 parse_uname (const char *str, int len, char **user, char **passwd)
508 /* Empty user name not allowed. */
511 colon = memchr (str, ':', len);
513 /* Empty user name again. */
518 int pwlen = len - (colon + 1 - str);
519 *passwd = xmalloc (pwlen + 1);
520 memcpy (*passwd, colon + 1, pwlen);
521 (*passwd)[pwlen] = '\0';
527 *user = xmalloc (len + 1);
528 memcpy (*user, str, len);
532 decode_string (*user);
534 decode_string (*passwd);
539 /* Used by main.c: detect URLs written using the "shorthand" URL forms
540 popularized by Netscape and NcFTP. HTTP shorthands look like this:
542 www.foo.com[:port]/dir/file -> http://www.foo.com[:port]/dir/file
543 www.foo.com[:port] -> http://www.foo.com[:port]
545 FTP shorthands look like this:
547 foo.bar.com:dir/file -> ftp://foo.bar.com/dir/file
548 foo.bar.com:/absdir/file -> ftp://foo.bar.com//absdir/file
550 If the URL needs not or cannot be rewritten, return NULL. */
552 rewrite_shorthand_url (const char *url)
556 if (url_has_scheme (url))
559 /* Look for a ':' or '/'. The former signifies NcFTP syntax, the
561 for (p = url; *p && *p != ':' && *p != '/'; p++)
571 /* If the characters after the colon and before the next slash
572 or end of string are all digits, it's HTTP. */
574 for (pp = p + 1; ISDIGIT (*pp); pp++)
576 if (digits > 0 && (*pp == '/' || *pp == '\0'))
579 /* Prepend "ftp://" to the entire URL... */
580 res = xmalloc (6 + strlen (url) + 1);
581 sprintf (res, "ftp://%s", url);
582 /* ...and replace ':' with '/'. */
583 res[6 + (p - url)] = '/';
590 /* Just prepend "http://" to what we have. */
591 res = xmalloc (7 + strlen (url) + 1);
592 sprintf (res, "http://%s", url);
597 static void parse_path PARAMS ((const char *, char **, char **));
600 strpbrk_or_eos (const char *s, const char *accept)
602 char *p = strpbrk (s, accept);
604 p = (char *)s + strlen (s);
608 /* Turn STR into lowercase; return non-zero if a character was
612 lowercase_str (char *str)
619 *str = TOLOWER (*str);
624 static char *parse_errors[] = {
625 #define PE_NO_ERROR 0
627 #define PE_UNSUPPORTED_SCHEME 1
628 "Unsupported scheme",
629 #define PE_EMPTY_HOST 2
631 #define PE_BAD_PORT_NUMBER 3
633 #define PE_INVALID_USER_NAME 4
635 #define PE_UNTERMINATED_IPV6_ADDRESS 5
636 "Unterminated IPv6 numeric address",
637 #define PE_INVALID_IPV6_ADDRESS 6
638 "Invalid char in IPv6 numeric address"
641 #define SETERR(p, v) do { \
648 Return a new struct url if successful, NULL on error. In case of
649 error, and if ERROR is not NULL, also set *ERROR to the appropriate
652 url_parse (const char *url, int *error)
656 int path_modified, host_modified;
658 enum url_scheme scheme;
660 const char *uname_b, *uname_e;
661 const char *host_b, *host_e;
662 const char *path_b, *path_e;
663 const char *params_b, *params_e;
664 const char *query_b, *query_e;
665 const char *fragment_b, *fragment_e;
668 char *user = NULL, *passwd = NULL;
672 scheme = url_scheme (url);
673 if (scheme == SCHEME_INVALID)
675 SETERR (error, PE_UNSUPPORTED_SCHEME);
679 url_encoded = reencode_string (url);
682 p += strlen (supported_schemes[scheme].leading_string);
684 p += url_skip_uname (p);
687 /* scheme://user:pass@host[:port]... */
690 /* We attempt to break down the URL into the components path,
691 params, query, and fragment. They are ordered like this:
693 scheme://host[:port][/path][;params][?query][#fragment] */
695 params_b = params_e = NULL;
696 query_b = query_e = NULL;
697 fragment_b = fragment_e = NULL;
703 /* Support http://[::1]/ used by IPv6. */
714 SETERR (error, PE_UNTERMINATED_IPV6_ADDRESS);
727 SETERR (error, PE_INVALID_IPV6_ADDRESS);
730 /* Don't include brackets in [host_b, host_p). */
736 p = strpbrk_or_eos (p, ":/;?#");
740 if (host_b == host_e)
742 SETERR (error, PE_EMPTY_HOST);
746 port = scheme_default_port (scheme);
749 const char *port_b, *port_e, *pp;
751 /* scheme://host:port/tralala */
755 p = strpbrk_or_eos (p, "/;?#");
758 if (port_b == port_e)
760 /* http://host:/whatever */
762 SETERR (error, PE_BAD_PORT_NUMBER);
766 for (port = 0, pp = port_b; pp < port_e; pp++)
770 /* http://host:12randomgarbage/blah */
772 SETERR (error, PE_BAD_PORT_NUMBER);
775 port = 10 * port + (*pp - '0');
783 p = strpbrk_or_eos (p, ";?#");
788 /* Path is not allowed not to exist. */
796 p = strpbrk_or_eos (p, "?#");
803 p = strpbrk_or_eos (p, "#");
806 /* Hack that allows users to use '?' (a wildcard character) in
807 FTP URLs without it being interpreted as a query string
809 if (scheme == SCHEME_FTP)
811 query_b = query_e = NULL;
824 if (uname_b != uname_e)
826 /* http://user:pass@host */
828 /* uname_b uname_e */
829 if (!parse_uname (uname_b, uname_e - uname_b - 1, &user, &passwd))
831 SETERR (error, PE_INVALID_USER_NAME);
836 u = (struct url *)xmalloc (sizeof (struct url));
837 memset (u, 0, sizeof (*u));
840 u->host = strdupdelim (host_b, host_e);
845 u->path = strdupdelim (path_b, path_e);
846 path_modified = path_simplify (u->path);
847 parse_path (u->path, &u->dir, &u->file);
849 host_modified = lowercase_str (u->host);
852 u->params = strdupdelim (params_b, params_e);
854 u->query = strdupdelim (query_b, query_e);
856 u->fragment = strdupdelim (fragment_b, fragment_e);
858 if (path_modified || u->fragment || host_modified || path_b == path_e)
860 /* If we suspect that a transformation has rendered what
861 url_string might return different from URL_ENCODED, rebuild
862 u->url using url_string. */
863 u->url = url_string (u, 0);
865 if (url_encoded != url)
866 xfree ((char *) url_encoded);
870 if (url_encoded == url)
871 u->url = xstrdup (url);
873 u->url = url_encoded;
881 url_error (int error_code)
883 assert (error_code >= 0 && error_code < ARRAY_SIZE (parse_errors));
884 return parse_errors[error_code];
888 parse_path (const char *quoted_path, char **dir, char **file)
890 char *path, *last_slash;
892 STRDUP_ALLOCA (path, quoted_path);
893 decode_string (path);
895 last_slash = strrchr (path, '/');
899 *file = xstrdup (path);
903 *dir = strdupdelim (path, last_slash);
904 *file = xstrdup (last_slash + 1);
908 /* Note: URL's "full path" is the path with the query string and
909 params appended. The "fragment" (#foo) is intentionally ignored,
910 but that might be changed. For example, if the original URL was
911 "http://host:port/foo/bar/baz;bullshit?querystring#uselessfragment",
912 the full path will be "/foo/bar/baz;bullshit?querystring". */
914 /* Return the length of the full path, without the terminating
918 full_path_length (const struct url *url)
922 #define FROB(el) if (url->el) len += 1 + strlen (url->el)
933 /* Write out the full path. */
936 full_path_write (const struct url *url, char *where)
938 #define FROB(el, chr) do { \
939 char *f_el = url->el; \
941 int l = strlen (f_el); \
943 memcpy (where, f_el, l); \
955 /* Public function for getting the "full path". E.g. if u->path is
956 "foo/bar" and u->query is "param=value", full_path will be
957 "/foo/bar?param=value". */
960 url_full_path (const struct url *url)
962 int length = full_path_length (url);
963 char *full_path = (char *)xmalloc(length + 1);
965 full_path_write (url, full_path);
966 full_path[length] = '\0';
971 /* Sync u->path and u->url with u->dir and u->file. */
974 sync_path (struct url *url)
982 newpath = xstrdup (url->file);
987 int dirlen = strlen (url->dir);
988 int filelen = strlen (url->file);
990 newpath = xmalloc (dirlen + 1 + filelen + 1);
991 memcpy (newpath, url->dir, dirlen);
992 newpath[dirlen] = '/';
993 memcpy (newpath + dirlen + 1, url->file, filelen);
994 newpath[dirlen + 1 + filelen] = '\0';
1000 /* Synchronize u->url. */
1002 url->url = url_string (url, 0);
1005 /* Mutators. Code in ftp.c insists on changing u->dir and u->file.
1006 This way we can sync u->path and u->url when they get changed. */
1009 url_set_dir (struct url *url, const char *newdir)
1012 url->dir = xstrdup (newdir);
1017 url_set_file (struct url *url, const char *newfile)
1020 url->file = xstrdup (newfile);
1025 url_free (struct url *url)
1031 FREE_MAYBE (url->params);
1032 FREE_MAYBE (url->query);
1033 FREE_MAYBE (url->fragment);
1034 FREE_MAYBE (url->user);
1035 FREE_MAYBE (url->passwd);
1044 get_urls_file (const char *file)
1046 struct file_memory *fm;
1047 struct urlpos *head, *tail;
1048 const char *text, *text_end;
1050 /* Load the file. */
1051 fm = read_file (file);
1054 logprintf (LOG_NOTQUIET, "%s: %s\n", file, strerror (errno));
1057 DEBUGP (("Loaded %s (size %ld).\n", file, fm->length));
1061 text_end = fm->content + fm->length;
1062 while (text < text_end)
1064 const char *line_beg = text;
1065 const char *line_end = memchr (text, '\n', text_end - text);
1067 line_end = text_end;
1072 /* Strip whitespace from the beginning and end of line. */
1073 while (line_beg < line_end && ISSPACE (*line_beg))
1075 while (line_end > line_beg && ISSPACE (*(line_end - 1)))
1078 if (line_end > line_beg)
1080 /* URL is in the [line_beg, line_end) region. */
1084 struct urlpos *entry;
1087 /* We must copy the URL to a zero-terminated string, and we
1088 can't use alloca because we're in a loop. *sigh*. */
1089 url_text = strdupdelim (line_beg, line_end);
1093 /* Merge opt.base_href with URL. */
1094 char *merged = uri_merge (opt.base_href, url_text);
1099 url = url_parse (url_text, &up_error_code);
1102 logprintf (LOG_NOTQUIET, "%s: Invalid URL %s: %s\n",
1103 file, url_text, url_error (up_error_code));
1109 entry = (struct urlpos *)xmalloc (sizeof (struct urlpos));
1110 memset (entry, 0, sizeof (*entry));
1121 read_file_free (fm);
1125 /* Free the linked list of urlpos. */
1127 free_urlpos (struct urlpos *l)
1131 struct urlpos *next = l->next;
1134 FREE_MAYBE (l->local_name);
1140 /* Rotate FNAME opt.backups times */
1142 rotate_backups(const char *fname)
1144 int maxlen = strlen (fname) + 1 + numdigit (opt.backups) + 1;
1145 char *from = (char *)alloca (maxlen);
1146 char *to = (char *)alloca (maxlen);
1150 if (stat (fname, &sb) == 0)
1151 if (S_ISREG (sb.st_mode) == 0)
1154 for (i = opt.backups; i > 1; i--)
1156 sprintf (from, "%s.%d", fname, i - 1);
1157 sprintf (to, "%s.%d", fname, i);
1158 /* #### This will fail on machines without the rename() system
1163 sprintf (to, "%s.%d", fname, 1);
1167 /* Create all the necessary directories for PATH (a file). Calls
1168 mkdirhier() internally. */
1170 mkalldirs (const char *path)
1177 p = path + strlen (path);
1178 for (; *p != '/' && p != path; p--);
1179 /* Don't create if it's just a file. */
1180 if ((p == path) && (*p != '/'))
1182 t = strdupdelim (path, p);
1183 /* Check whether the directory exists. */
1184 if ((stat (t, &st) == 0))
1186 if (S_ISDIR (st.st_mode))
1193 /* If the dir exists as a file name, remove it first. This
1194 is *only* for Wget to work with buggy old CERN http
1195 servers. Here is the scenario: When Wget tries to
1196 retrieve a directory without a slash, e.g.
1197 http://foo/bar (bar being a directory), CERN server will
1198 not redirect it too http://foo/bar/ -- it will generate a
1199 directory listing containing links to bar/file1,
1200 bar/file2, etc. Wget will lose because it saves this
1201 HTML listing to a file `bar', so it cannot create the
1202 directory. To work around this, if the file of the same
1203 name exists, we just remove it and create the directory
1205 DEBUGP (("Removing %s because of directory danger!\n", t));
1209 res = make_directory (t);
1211 logprintf (LOG_NOTQUIET, "%s: %s", t, strerror (errno));
1217 count_slashes (const char *s)
1226 /* Return the path name of the URL-equivalent file name, with a
1227 remote-like structure of directories. */
1229 mkstruct (const struct url *u)
1231 char *dir, *dir_preencoding;
1232 char *file, *res, *dirpref;
1233 char *query = u->query && *u->query ? u->query : NULL;
1238 char *ptr = u->dir + (*u->dir == '/');
1239 int slash_count = 1 + count_slashes (ptr);
1240 int cut = MINVAL (opt.cut_dirs, slash_count);
1241 for (; cut && *ptr; ptr++)
1244 STRDUP_ALLOCA (dir, ptr);
1247 dir = u->dir + (*u->dir == '/');
1249 /* Check for the true name (or at least a consistent name for saving
1250 to directory) of HOST, reusing the hlist if possible. */
1251 if (opt.add_hostdir)
1253 /* Add dir_prefix and hostname (if required) to the beginning of
1255 dirpref = (char *)alloca (strlen (opt.dir_prefix) + 1
1257 + 1 + numdigit (u->port)
1259 if (!DOTP (opt.dir_prefix))
1260 sprintf (dirpref, "%s/%s", opt.dir_prefix, u->host);
1262 strcpy (dirpref, u->host);
1264 if (u->port != scheme_default_port (u->scheme))
1266 int len = strlen (dirpref);
1268 number_to_string (dirpref + len + 1, u->port);
1271 else /* not add_hostdir */
1273 if (!DOTP (opt.dir_prefix))
1274 dirpref = opt.dir_prefix;
1279 /* If there is a prefix, prepend it. */
1282 char *newdir = (char *)alloca (strlen (dirpref) + 1 + strlen (dir) + 2);
1283 sprintf (newdir, "%s%s%s", dirpref, *dir == '/' ? "" : "/", dir);
1287 dir_preencoding = dir;
1288 dir = reencode_string (dir_preencoding);
1291 if (l && dir[l - 1] == '/')
1295 file = "index.html";
1299 /* Finally, construct the full name. */
1300 res = (char *)xmalloc (strlen (dir) + 1 + strlen (file)
1301 + (query ? (1 + strlen (query)) : 0)
1303 sprintf (res, "%s%s%s", dir, *dir ? "/" : "", file);
1307 strcat (res, query);
1309 if (dir != dir_preencoding)
1314 /* Compose a file name out of BASE, an unescaped file name, and QUERY,
1315 an escaped query string. The trick is to make sure that unsafe
1316 characters in BASE are escaped, and that slashes in QUERY are also
1320 compose_file_name (char *base, char *query)
1326 /* Copy BASE to RESULT and encode all unsafe characters. */
1328 while (*from && to - result < sizeof (result))
1330 if (UNSAFE_CHAR (*from))
1332 unsigned char c = *from++;
1334 *to++ = XDIGIT_TO_XCHAR (c >> 4);
1335 *to++ = XDIGIT_TO_XCHAR (c & 0xf);
1341 if (query && to - result < sizeof (result))
1345 /* Copy QUERY to RESULT and encode all '/' characters. */
1347 while (*from && to - result < sizeof (result))
1361 if (to - result < sizeof (result))
1364 /* Truncate input which is too long, presumably due to a huge
1366 result[sizeof (result) - 1] = '\0';
1368 return xstrdup (result);
1371 /* Create a unique filename, corresponding to a given URL. Calls
1372 mkstruct if necessary. Does *not* actually create any directories. */
1374 url_filename (const struct url *u)
1377 int have_prefix = 0; /* whether we must prepend opt.dir_prefix */
1381 file = mkstruct (u);
1386 char *base = *u->file ? u->file : "index.html";
1387 char *query = u->query && *u->query ? u->query : NULL;
1388 file = compose_file_name (base, query);
1393 /* Check whether the prefix directory is something other than "."
1394 before prepending it. */
1395 if (!DOTP (opt.dir_prefix))
1397 char *nfile = (char *)xmalloc (strlen (opt.dir_prefix)
1398 + 1 + strlen (file) + 1);
1399 sprintf (nfile, "%s/%s", opt.dir_prefix, file);
1404 /* DOS-ish file systems don't like `%' signs in them; we change it
1409 for (p = file; *p; p++)
1413 #endif /* WINDOWS */
1415 /* Check the cases in which the unique extensions are not used:
1416 1) Clobbering is turned off (-nc).
1417 2) Retrieval with regetting.
1418 3) Timestamping is used.
1419 4) Hierarchy is built.
1421 The exception is the case when file does exist and is a
1422 directory (actually support for bad httpd-s). */
1423 if ((opt.noclobber || opt.always_rest || opt.timestamping || opt.dirstruct)
1424 && !(file_exists_p (file) && !file_non_directory_p (file)))
1427 /* Find a unique name. */
1428 name = unique_name (file);
1433 /* Return the langth of URL's path. Path is considered to be
1434 terminated by one of '?', ';', '#', or by the end of the
1437 path_length (const char *url)
1439 const char *q = strpbrk_or_eos (url, "?;#");
1443 /* Find the last occurrence of character C in the range [b, e), or
1444 NULL, if none are present. This is equivalent to strrchr(b, c),
1445 except that it accepts an END argument instead of requiring the
1446 string to be zero-terminated. Why is there no memrchr()? */
1448 find_last_char (const char *b, const char *e, char c)
1456 /* Resolve "." and ".." elements of PATH by destructively modifying
1457 PATH. "." is resolved by removing that path element, and ".." is
1458 resolved by removing the preceding path element. Leading and
1459 trailing slashes are preserved.
1461 Return non-zero if any changes have been made.
1463 For example, "a/b/c/./../d/.." will yield "a/b/". More exhaustive
1464 test examples are provided below. If you change anything in this
1465 function, run test_path_simplify to make sure you haven't broken a
1468 A previous version of this function was based on path_simplify()
1469 from GNU Bash, but it has been rewritten for Wget 1.8.1. */
1472 path_simplify (char *path)
1478 ++path; /* preserve the leading '/'. */
1481 end = p + strlen (p) + 1; /* position past the terminating zero. */
1486 /* P should point to the beginning of a path element. */
1488 if (*p == '.' && (*(p + 1) == '/' || *(p + 1) == '\0'))
1490 /* Handle "./foo" by moving "foo" two characters to the
1492 if (*(p + 1) == '/')
1495 memmove (p, p + 2, end - p);
1506 else if (*p == '.' && *(p + 1) == '.'
1507 && (*(p + 2) == '/' || *(p + 2) == '\0'))
1509 /* Handle "../foo" by moving "foo" one path element to the
1511 char *b = p; /* not p-1 because P can equal PATH */
1513 /* Backtrack by one path element, but not past the beginning
1516 /* foo/bar/../baz */
1522 /* Move backwards until B hits the beginning of the
1523 previous path element or the beginning of path. */
1524 for (--b; b > path && *(b - 1) != '/'; b--)
1529 if (*(p + 2) == '/')
1531 memmove (b, p + 3, end - (p + 3));
1545 /* Remove empty path elements. Not mandated by rfc1808 et
1546 al, but empty path elements are not all that useful, and
1547 the rest of Wget might not deal with them well. */
1557 memmove (p, q, end - q);
1562 /* Skip to the next path element. */
1563 while (*p && *p != '/')
1568 /* Make sure P points to the beginning of the next path element,
1569 which is location after the slash. */
1576 /* Resolve the result of "linking" a base URI (BASE) to a
1577 link-specified URI (LINK).
1579 Either of the URIs may be absolute or relative, complete with the
1580 host name, or path only. This tries to behave "reasonably" in all
1581 foreseeable cases. It employs little specific knowledge about
1582 schemes or URL-specific stuff -- it just works on strings.
1584 The parameters LINKLENGTH is useful if LINK is not zero-terminated.
1585 See uri_merge for a gentler interface to this functionality.
1587 Perhaps this function should call path_simplify so that the callers
1588 don't have to call url_parse unconditionally. */
1590 uri_merge_1 (const char *base, const char *link, int linklength, int no_scheme)
1596 const char *end = base + path_length (base);
1600 /* Empty LINK points back to BASE, query string and all. */
1601 constr = xstrdup (base);
1603 else if (*link == '?')
1605 /* LINK points to the same location, but changes the query
1606 string. Examples: */
1607 /* uri_merge("path", "?new") -> "path?new" */
1608 /* uri_merge("path?foo", "?new") -> "path?new" */
1609 /* uri_merge("path?foo#bar", "?new") -> "path?new" */
1610 /* uri_merge("path#foo", "?new") -> "path?new" */
1611 int baselength = end - base;
1612 constr = xmalloc (baselength + linklength + 1);
1613 memcpy (constr, base, baselength);
1614 memcpy (constr + baselength, link, linklength);
1615 constr[baselength + linklength] = '\0';
1617 else if (*link == '#')
1619 /* uri_merge("path", "#new") -> "path#new" */
1620 /* uri_merge("path#foo", "#new") -> "path#new" */
1621 /* uri_merge("path?foo", "#new") -> "path?foo#new" */
1622 /* uri_merge("path?foo#bar", "#new") -> "path?foo#new" */
1624 const char *end1 = strchr (base, '#');
1626 end1 = base + strlen (base);
1627 baselength = end1 - base;
1628 constr = xmalloc (baselength + linklength + 1);
1629 memcpy (constr, base, baselength);
1630 memcpy (constr + baselength, link, linklength);
1631 constr[baselength + linklength] = '\0';
1633 else if (linklength > 1 && *link == '/' && *(link + 1) == '/')
1635 /* LINK begins with "//" and so is a net path: we need to
1636 replace everything after (and including) the double slash
1639 /* uri_merge("foo", "//new/bar") -> "//new/bar" */
1640 /* uri_merge("//old/foo", "//new/bar") -> "//new/bar" */
1641 /* uri_merge("http://old/foo", "//new/bar") -> "http://new/bar" */
1645 const char *start_insert;
1647 /* Look for first slash. */
1648 slash = memchr (base, '/', end - base);
1649 /* If found slash and it is a double slash, then replace
1650 from this point, else default to replacing from the
1652 if (slash && *(slash + 1) == '/')
1653 start_insert = slash;
1655 start_insert = base;
1657 span = start_insert - base;
1658 constr = (char *)xmalloc (span + linklength + 1);
1660 memcpy (constr, base, span);
1661 memcpy (constr + span, link, linklength);
1662 constr[span + linklength] = '\0';
1664 else if (*link == '/')
1666 /* LINK is an absolute path: we need to replace everything
1667 after (and including) the FIRST slash with LINK.
1669 So, if BASE is "http://host/whatever/foo/bar", and LINK is
1670 "/qux/xyzzy", our result should be
1671 "http://host/qux/xyzzy". */
1674 const char *start_insert = NULL; /* for gcc to shut up. */
1675 const char *pos = base;
1676 int seen_slash_slash = 0;
1677 /* We're looking for the first slash, but want to ignore
1680 slash = memchr (pos, '/', end - pos);
1681 if (slash && !seen_slash_slash)
1682 if (*(slash + 1) == '/')
1685 seen_slash_slash = 1;
1689 /* At this point, SLASH is the location of the first / after
1690 "//", or the first slash altogether. START_INSERT is the
1691 pointer to the location where LINK will be inserted. When
1692 examining the last two examples, keep in mind that LINK
1695 if (!slash && !seen_slash_slash)
1696 /* example: "foo" */
1698 start_insert = base;
1699 else if (!slash && seen_slash_slash)
1700 /* example: "http://foo" */
1703 else if (slash && !seen_slash_slash)
1704 /* example: "foo/bar" */
1706 start_insert = base;
1707 else if (slash && seen_slash_slash)
1708 /* example: "http://something/" */
1710 start_insert = slash;
1712 span = start_insert - base;
1713 constr = (char *)xmalloc (span + linklength + 1);
1715 memcpy (constr, base, span);
1717 memcpy (constr + span, link, linklength);
1718 constr[span + linklength] = '\0';
1722 /* LINK is a relative URL: we need to replace everything
1723 after last slash (possibly empty) with LINK.
1725 So, if BASE is "whatever/foo/bar", and LINK is "qux/xyzzy",
1726 our result should be "whatever/foo/qux/xyzzy". */
1727 int need_explicit_slash = 0;
1729 const char *start_insert;
1730 const char *last_slash = find_last_char (base, end, '/');
1733 /* No slash found at all. Append LINK to what we have,
1734 but we'll need a slash as a separator.
1736 Example: if base == "foo" and link == "qux/xyzzy", then
1737 we cannot just append link to base, because we'd get
1738 "fooqux/xyzzy", whereas what we want is
1741 To make sure the / gets inserted, we set
1742 need_explicit_slash to 1. We also set start_insert
1743 to end + 1, so that the length calculations work out
1744 correctly for one more (slash) character. Accessing
1745 that character is fine, since it will be the
1746 delimiter, '\0' or '?'. */
1747 /* example: "foo?..." */
1748 /* ^ ('?' gets changed to '/') */
1749 start_insert = end + 1;
1750 need_explicit_slash = 1;
1752 else if (last_slash && last_slash != base && *(last_slash - 1) == '/')
1754 /* example: http://host" */
1756 start_insert = end + 1;
1757 need_explicit_slash = 1;
1761 /* example: "whatever/foo/bar" */
1763 start_insert = last_slash + 1;
1766 span = start_insert - base;
1767 constr = (char *)xmalloc (span + linklength + 1);
1769 memcpy (constr, base, span);
1770 if (need_explicit_slash)
1771 constr[span - 1] = '/';
1773 memcpy (constr + span, link, linklength);
1774 constr[span + linklength] = '\0';
1777 else /* !no_scheme */
1779 constr = strdupdelim (link, link + linklength);
1784 /* Merge BASE with LINK and return the resulting URI. This is an
1785 interface to uri_merge_1 that assumes that LINK is a
1786 zero-terminated string. */
1788 uri_merge (const char *base, const char *link)
1790 return uri_merge_1 (base, link, strlen (link), !url_has_scheme (link));
1793 #define APPEND(p, s) do { \
1794 int len = strlen (s); \
1795 memcpy (p, s, len); \
1799 /* Use this instead of password when the actual password is supposed
1800 to be hidden. We intentionally use a generic string without giving
1801 away the number of characters in the password, like previous
1803 #define HIDDEN_PASSWORD "*password*"
1805 /* Recreate the URL string from the data in URL.
1807 If HIDE is non-zero (as it is when we're calling this on a URL we
1808 plan to print, but not when calling it to canonicalize a URL for
1809 use within the program), password will be hidden. Unsafe
1810 characters in the URL will be quoted. */
1813 url_string (const struct url *url, int hide_password)
1817 char *quoted_user = NULL, *quoted_passwd = NULL;
1819 int scheme_port = supported_schemes[url->scheme].default_port;
1820 char *scheme_str = supported_schemes[url->scheme].leading_string;
1821 int fplen = full_path_length (url);
1823 int brackets_around_host = 0;
1825 assert (scheme_str != NULL);
1827 /* Make sure the user name and password are quoted. */
1830 quoted_user = encode_string_maybe (url->user);
1834 quoted_passwd = HIDDEN_PASSWORD;
1836 quoted_passwd = encode_string_maybe (url->passwd);
1840 if (strchr (url->host, ':'))
1841 brackets_around_host = 1;
1843 size = (strlen (scheme_str)
1844 + strlen (url->host)
1845 + (brackets_around_host ? 2 : 0)
1848 if (url->port != scheme_port)
1849 size += 1 + numdigit (url->port);
1852 size += 1 + strlen (quoted_user);
1854 size += 1 + strlen (quoted_passwd);
1857 p = result = xmalloc (size);
1859 APPEND (p, scheme_str);
1862 APPEND (p, quoted_user);
1866 APPEND (p, quoted_passwd);
1871 if (brackets_around_host)
1873 APPEND (p, url->host);
1874 if (brackets_around_host)
1876 if (url->port != scheme_port)
1879 p = number_to_string (p, url->port);
1882 full_path_write (url, p);
1886 assert (p - result == size);
1888 if (quoted_user && quoted_user != url->user)
1889 xfree (quoted_user);
1890 if (quoted_passwd && !hide_password
1891 && quoted_passwd != url->passwd)
1892 xfree (quoted_passwd);
1897 /* Returns proxy host address, in accordance with SCHEME. */
1899 getproxy (enum url_scheme scheme)
1902 char *rewritten_url;
1903 static char rewritten_storage[1024];
1908 proxy = opt.http_proxy ? opt.http_proxy : getenv ("http_proxy");
1912 proxy = opt.https_proxy ? opt.https_proxy : getenv ("https_proxy");
1916 proxy = opt.ftp_proxy ? opt.ftp_proxy : getenv ("ftp_proxy");
1918 case SCHEME_INVALID:
1921 if (!proxy || !*proxy)
1924 /* Handle shorthands. */
1925 rewritten_url = rewrite_shorthand_url (proxy);
1928 strncpy (rewritten_storage, rewritten_url, sizeof(rewritten_storage));
1929 rewritten_storage[sizeof (rewritten_storage) - 1] = '\0';
1930 proxy = rewritten_storage;
1936 /* Should a host be accessed through proxy, concerning no_proxy? */
1938 no_proxy_match (const char *host, const char **no_proxy)
1943 return !sufmatch (no_proxy, host);
1946 /* Support for converting links for local viewing in downloaded HTML
1947 files. This should be moved to another file, because it has
1948 nothing to do with processing URLs. */
1950 static void write_backup_file PARAMS ((const char *, downloaded_file_t));
1951 static const char *replace_attr PARAMS ((const char *, int, FILE *,
1953 static const char *replace_attr_refresh_hack PARAMS ((const char *, int, FILE *,
1954 const char *, int));
1955 static char *local_quote_string PARAMS ((const char *));
1957 /* Change the links in one HTML file. LINKS is a list of links in the
1958 document, along with their positions and the desired direction of
1961 convert_links (const char *file, struct urlpos *links)
1963 struct file_memory *fm;
1966 downloaded_file_t downloaded_file_return;
1968 struct urlpos *link;
1969 int to_url_count = 0, to_file_count = 0;
1971 logprintf (LOG_VERBOSE, _("Converting %s... "), file);
1974 /* First we do a "dry run": go through the list L and see whether
1975 any URL needs to be converted in the first place. If not, just
1976 leave the file alone. */
1978 struct urlpos *dry = links;
1979 for (dry = links; dry; dry = dry->next)
1980 if (dry->convert != CO_NOCONVERT)
1984 logputs (LOG_VERBOSE, _("nothing to do.\n"));
1989 fm = read_file (file);
1992 logprintf (LOG_NOTQUIET, _("Cannot convert links in %s: %s\n"),
1993 file, strerror (errno));
1997 downloaded_file_return = downloaded_file (CHECK_FOR_FILE, file);
1998 if (opt.backup_converted && downloaded_file_return)
1999 write_backup_file (file, downloaded_file_return);
2001 /* Before opening the file for writing, unlink the file. This is
2002 important if the data in FM is mmaped. In such case, nulling the
2003 file, which is what fopen() below does, would make us read all
2004 zeroes from the mmaped region. */
2005 if (unlink (file) < 0 && errno != ENOENT)
2007 logprintf (LOG_NOTQUIET, _("Unable to delete `%s': %s\n"),
2008 file, strerror (errno));
2009 read_file_free (fm);
2012 /* Now open the file for writing. */
2013 fp = fopen (file, "wb");
2016 logprintf (LOG_NOTQUIET, _("Cannot convert links in %s: %s\n"),
2017 file, strerror (errno));
2018 read_file_free (fm);
2022 /* Here we loop through all the URLs in file, replacing those of
2023 them that are downloaded with relative references. */
2025 for (link = links; link; link = link->next)
2027 char *url_start = fm->content + link->pos;
2029 if (link->pos >= fm->length)
2031 DEBUGP (("Something strange is going on. Please investigate."));
2034 /* If the URL is not to be converted, skip it. */
2035 if (link->convert == CO_NOCONVERT)
2037 DEBUGP (("Skipping %s at position %d.\n", link->url->url, link->pos));
2041 /* Echo the file contents, up to the offending URL's opening
2042 quote, to the outfile. */
2043 fwrite (p, 1, url_start - p, fp);
2046 switch (link->convert)
2048 case CO_CONVERT_TO_RELATIVE:
2049 /* Convert absolute URL to relative. */
2051 char *newname = construct_relative (file, link->local_name);
2052 char *quoted_newname = local_quote_string (newname);
2054 if (!link->link_refresh_p)
2055 p = replace_attr (p, link->size, fp, quoted_newname);
2057 p = replace_attr_refresh_hack (p, link->size, fp, quoted_newname,
2058 link->refresh_timeout);
2060 DEBUGP (("TO_RELATIVE: %s to %s at position %d in %s.\n",
2061 link->url->url, newname, link->pos, file));
2063 xfree (quoted_newname);
2067 case CO_CONVERT_TO_COMPLETE:
2068 /* Convert the link to absolute URL. */
2070 char *newlink = link->url->url;
2071 char *quoted_newlink = html_quote_string (newlink);
2073 if (!link->link_refresh_p)
2074 p = replace_attr (p, link->size, fp, quoted_newlink);
2076 p = replace_attr_refresh_hack (p, link->size, fp, quoted_newlink,
2077 link->refresh_timeout);
2079 DEBUGP (("TO_COMPLETE: <something> to %s at position %d in %s.\n",
2080 newlink, link->pos, file));
2081 xfree (quoted_newlink);
2085 case CO_NULLIFY_BASE:
2086 /* Change the base href to "". */
2087 p = replace_attr (p, link->size, fp, "");
2095 /* Output the rest of the file. */
2096 if (p - fm->content < fm->length)
2097 fwrite (p, 1, fm->length - (p - fm->content), fp);
2099 read_file_free (fm);
2101 logprintf (LOG_VERBOSE, "%d-%d\n", to_file_count, to_url_count);
2104 /* Construct and return a malloced copy of the relative link from two
2105 pieces of information: local name S1 of the referring file and
2106 local name S2 of the referred file.
2108 So, if S1 is "jagor.srce.hr/index.html" and S2 is
2109 "jagor.srce.hr/images/news.gif", the function will return
2112 Alternately, if S1 is "fly.cc.fer.hr/ioccc/index.html", and S2 is
2113 "fly.cc.fer.hr/images/fly.gif", the function will return
2114 "../images/fly.gif".
2116 Caveats: S1 should not begin with `/', unless S2 also begins with
2117 '/'. S1 should not contain things like ".." and such --
2118 construct_relative ("fly/ioccc/../index.html",
2119 "fly/images/fly.gif") will fail. (A workaround is to call
2120 something like path_simplify() on S1). */
2122 construct_relative (const char *s1, const char *s2)
2124 int i, cnt, sepdirs1;
2128 return xstrdup (s2);
2129 /* S1 should *not* be absolute, if S2 wasn't. */
2130 assert (*s1 != '/');
2132 /* Skip the directories common to both strings. */
2135 while (s1[i] && s2[i]
2140 if (s1[i] == '/' && s2[i] == '/')
2145 for (sepdirs1 = 0; s1[i]; i++)
2148 /* Now, construct the file as of:
2149 - ../ repeated sepdirs1 time
2150 - all the non-mutual directories of S2. */
2151 res = (char *)xmalloc (3 * sepdirs1 + strlen (s2 + cnt) + 1);
2152 for (i = 0; i < sepdirs1; i++)
2153 memcpy (res + 3 * i, "../", 3);
2154 strcpy (res + 3 * i, s2 + cnt);
2159 write_backup_file (const char *file, downloaded_file_t downloaded_file_return)
2161 /* Rather than just writing over the original .html file with the
2162 converted version, save the former to *.orig. Note we only do
2163 this for files we've _successfully_ downloaded, so we don't
2164 clobber .orig files sitting around from previous invocations. */
2166 /* Construct the backup filename as the original name plus ".orig". */
2167 size_t filename_len = strlen(file);
2168 char* filename_plus_orig_suffix;
2169 boolean already_wrote_backup_file = FALSE;
2170 slist* converted_file_ptr;
2171 static slist* converted_files = NULL;
2173 if (downloaded_file_return == FILE_DOWNLOADED_AND_HTML_EXTENSION_ADDED)
2175 /* Just write "orig" over "html". We need to do it this way
2176 because when we're checking to see if we've downloaded the
2177 file before (to see if we can skip downloading it), we don't
2178 know if it's a text/html file. Therefore we don't know yet
2179 at that stage that -E is going to cause us to tack on
2180 ".html", so we need to compare vs. the original URL plus
2181 ".orig", not the original URL plus ".html.orig". */
2182 filename_plus_orig_suffix = alloca (filename_len + 1);
2183 strcpy(filename_plus_orig_suffix, file);
2184 strcpy((filename_plus_orig_suffix + filename_len) - 4, "orig");
2186 else /* downloaded_file_return == FILE_DOWNLOADED_NORMALLY */
2188 /* Append ".orig" to the name. */
2189 filename_plus_orig_suffix = alloca (filename_len + sizeof(".orig"));
2190 strcpy(filename_plus_orig_suffix, file);
2191 strcpy(filename_plus_orig_suffix + filename_len, ".orig");
2194 /* We can get called twice on the same URL thanks to the
2195 convert_all_links() call in main(). If we write the .orig file
2196 each time in such a case, it'll end up containing the first-pass
2197 conversion, not the original file. So, see if we've already been
2198 called on this file. */
2199 converted_file_ptr = converted_files;
2200 while (converted_file_ptr != NULL)
2201 if (strcmp(converted_file_ptr->string, file) == 0)
2203 already_wrote_backup_file = TRUE;
2207 converted_file_ptr = converted_file_ptr->next;
2209 if (!already_wrote_backup_file)
2211 /* Rename <file> to <file>.orig before former gets written over. */
2212 if (rename(file, filename_plus_orig_suffix) != 0)
2213 logprintf (LOG_NOTQUIET, _("Cannot back up %s as %s: %s\n"),
2214 file, filename_plus_orig_suffix, strerror (errno));
2216 /* Remember that we've already written a .orig backup for this file.
2217 Note that we never free this memory since we need it till the
2218 convert_all_links() call, which is one of the last things the
2219 program does before terminating. BTW, I'm not sure if it would be
2220 safe to just set 'converted_file_ptr->string' to 'file' below,
2221 rather than making a copy of the string... Another note is that I
2222 thought I could just add a field to the urlpos structure saying
2223 that we'd written a .orig file for this URL, but that didn't work,
2224 so I had to make this separate list.
2225 -- Dan Harkless <wget@harkless.org>
2227 This [adding a field to the urlpos structure] didn't work
2228 because convert_file() is called from convert_all_links at
2229 the end of the retrieval with a freshly built new urlpos
2231 -- Hrvoje Niksic <hniksic@arsdigita.com>
2233 converted_file_ptr = xmalloc(sizeof(*converted_file_ptr));
2234 converted_file_ptr->string = xstrdup(file); /* die on out-of-mem. */
2235 converted_file_ptr->next = converted_files;
2236 converted_files = converted_file_ptr;
2240 static int find_fragment PARAMS ((const char *, int, const char **,
2243 /* Replace an attribute's original text with NEW_TEXT. */
2246 replace_attr (const char *p, int size, FILE *fp, const char *new_text)
2249 char quote_char = '\"'; /* use "..." for quoting, unless the
2250 original value is quoted, in which
2251 case reuse its quoting char. */
2252 const char *frag_beg, *frag_end;
2254 /* Structure of our string is:
2255 "...old-contents..."
2256 <--- size ---> (with quotes)
2259 <--- size --> (no quotes) */
2261 if (*p == '\"' || *p == '\'')
2266 size -= 2; /* disregard opening and closing quote */
2268 putc (quote_char, fp);
2269 fputs (new_text, fp);
2271 /* Look for fragment identifier, if any. */
2272 if (find_fragment (p, size, &frag_beg, &frag_end))
2273 fwrite (frag_beg, 1, frag_end - frag_beg, fp);
2277 putc (quote_char, fp);
2282 /* The same as REPLACE_ATTR, but used when replacing
2283 <meta http-equiv=refresh content="new_text"> because we need to
2284 append "timeout_value; URL=" before the next_text. */
2287 replace_attr_refresh_hack (const char *p, int size, FILE *fp,
2288 const char *new_text, int timeout)
2291 char *new_with_timeout = (char *)alloca (numdigit (timeout)
2295 sprintf (new_with_timeout, "%d; URL=%s", timeout, new_text);
2297 return replace_attr (p, size, fp, new_with_timeout);
2300 /* Find the first occurrence of '#' in [BEG, BEG+SIZE) that is not
2301 preceded by '&'. If the character is not found, return zero. If
2302 the character is found, return 1 and set BP and EP to point to the
2303 beginning and end of the region.
2305 This is used for finding the fragment indentifiers in URLs. */
2308 find_fragment (const char *beg, int size, const char **bp, const char **ep)
2310 const char *end = beg + size;
2312 for (; beg < end; beg++)
2334 /* Quote FILE for use as local reference to an HTML file.
2336 We quote ? as %3F to avoid passing part of the file name as the
2337 parameter when browsing the converted file through HTTP. However,
2338 it is safe to do this only when `--html-extension' is turned on.
2339 This is because converting "index.html?foo=bar" to
2340 "index.html%3Ffoo=bar" would break local browsing, as the latter
2341 isn't even recognized as an HTML file! However, converting
2342 "index.html?foo=bar.html" to "index.html%3Ffoo=bar.html" should be
2343 safe for both local and HTTP-served browsing. */
2346 local_quote_string (const char *file)
2348 const char *file_sans_qmark;
2351 if (!opt.html_extension)
2352 return html_quote_string (file);
2354 qm = count_char (file, '?');
2358 const char *from = file;
2361 /* qm * 2 because we replace each question mark with "%3F",
2362 i.e. replace one char with three, hence two more. */
2363 int fsqlen = strlen (file) + qm * 2;
2365 to = newname = (char *)alloca (fsqlen + 1);
2366 for (; *from; from++)
2377 assert (to - newname == fsqlen);
2380 file_sans_qmark = newname;
2383 file_sans_qmark = file;
2385 return html_quote_string (file_sans_qmark);
2388 /* We're storing "modes" of type downloaded_file_t in the hash table.
2389 However, our hash tables only accept pointers for keys and values.
2390 So when we need a pointer, we use the address of a
2391 downloaded_file_t variable of static storage. */
2393 static downloaded_file_t *
2394 downloaded_mode_to_ptr (downloaded_file_t mode)
2396 static downloaded_file_t
2397 v1 = FILE_NOT_ALREADY_DOWNLOADED,
2398 v2 = FILE_DOWNLOADED_NORMALLY,
2399 v3 = FILE_DOWNLOADED_AND_HTML_EXTENSION_ADDED,
2400 v4 = CHECK_FOR_FILE;
2404 case FILE_NOT_ALREADY_DOWNLOADED:
2406 case FILE_DOWNLOADED_NORMALLY:
2408 case FILE_DOWNLOADED_AND_HTML_EXTENSION_ADDED:
2410 case CHECK_FOR_FILE:
2416 /* This should really be merged with dl_file_url_map and
2417 downloaded_html_files in recur.c. This was originally a list, but
2418 I changed it to a hash table beause it was actually taking a lot of
2419 time to find things in it. */
2421 static struct hash_table *downloaded_files_hash;
2423 /* Remembers which files have been downloaded. In the standard case, should be
2424 called with mode == FILE_DOWNLOADED_NORMALLY for each file we actually
2425 download successfully (i.e. not for ones we have failures on or that we skip
2428 When we've downloaded a file and tacked on a ".html" extension due to -E,
2429 call this function with FILE_DOWNLOADED_AND_HTML_EXTENSION_ADDED rather than
2430 FILE_DOWNLOADED_NORMALLY.
2432 If you just want to check if a file has been previously added without adding
2433 it, call with mode == CHECK_FOR_FILE. Please be sure to call this function
2434 with local filenames, not remote URLs. */
2436 downloaded_file (downloaded_file_t mode, const char *file)
2438 downloaded_file_t *ptr;
2440 if (mode == CHECK_FOR_FILE)
2442 if (!downloaded_files_hash)
2443 return FILE_NOT_ALREADY_DOWNLOADED;
2444 ptr = hash_table_get (downloaded_files_hash, file);
2446 return FILE_NOT_ALREADY_DOWNLOADED;
2450 if (!downloaded_files_hash)
2451 downloaded_files_hash = make_string_hash_table (0);
2453 ptr = hash_table_get (downloaded_files_hash, file);
2457 ptr = downloaded_mode_to_ptr (mode);
2458 hash_table_put (downloaded_files_hash, xstrdup (file), &ptr);
2460 return FILE_NOT_ALREADY_DOWNLOADED;
2464 df_free_mapper (void *key, void *value, void *ignored)
2471 downloaded_files_free (void)
2473 if (downloaded_files_hash)
2475 hash_table_map (downloaded_files_hash, df_free_mapper, NULL);
2476 hash_table_destroy (downloaded_files_hash);
2477 downloaded_files_hash = NULL;
2482 /* Debugging and testing support for path_simplify. */
2484 /* Debug: run path_simplify on PATH and return the result in a new
2485 string. Useful for calling from the debugger. */
2489 char *copy = xstrdup (path);
2490 path_simplify (copy);
2495 run_test (char *test, char *expected_result, int expected_change)
2497 char *test_copy = xstrdup (test);
2498 int modified = path_simplify (test_copy);
2500 if (0 != strcmp (test_copy, expected_result))
2502 printf ("Failed path_simplify(\"%s\"): expected \"%s\", got \"%s\".\n",
2503 test, expected_result, test_copy);
2505 if (modified != expected_change)
2507 if (expected_change == 1)
2508 printf ("Expected no modification with path_simplify(\"%s\").\n",
2511 printf ("Expected modification with path_simplify(\"%s\").\n",
2518 test_path_simplify (void)
2521 char *test, *result;
2527 { "foo", "foo", 0 },
2528 { "foo/bar", "foo/bar", 0 },
2529 { "foo///bar", "foo/bar", 1 },
2530 { "foo/.", "foo/", 1 },
2531 { "foo/./", "foo/", 1 },
2532 { "foo./", "foo./", 0 },
2533 { "foo/../bar", "bar", 1 },
2534 { "foo/../bar/", "bar/", 1 },
2535 { "foo/bar/..", "foo/", 1 },
2536 { "foo/bar/../x", "foo/x", 1 },
2537 { "foo/bar/../x/", "foo/x/", 1 },
2538 { "foo/..", "", 1 },
2539 { "foo/../..", "", 1 },
2540 { "a/b/../../c", "c", 1 },
2541 { "./a/../b", "b", 1 }
2545 for (i = 0; i < ARRAY_SIZE (tests); i++)
2547 char *test = tests[i].test;
2548 char *expected_result = tests[i].result;
2549 int expected_change = tests[i].should_modify;
2550 run_test (test, expected_result, expected_change);
2553 /* Now run all the tests with a leading slash before the test case,
2554 to prove that the slash is being preserved. */
2555 for (i = 0; i < ARRAY_SIZE (tests); i++)
2557 char *test, *expected_result;
2558 int expected_change = tests[i].should_modify;
2560 test = xmalloc (1 + strlen (tests[i].test) + 1);
2561 sprintf (test, "/%s", tests[i].test);
2563 expected_result = xmalloc (1 + strlen (tests[i].result) + 1);
2564 sprintf (expected_result, "/%s", tests[i].result);
2566 run_test (test, expected_result, expected_change);
2569 xfree (expected_result);