1 if [ ! "$_MEDIA_HTTP_SUBR" ]; then _MEDIA_HTTP_SUBR=1
3 # Copyright (c) 2012-2013 Devin Teske
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
9 # 1. Redistributions of source code must retain the above copyright
10 # notice, this list of conditions and the following disclaimer.
11 # 2. Redistributions in binary form must reproduce the above copyright
12 # notice, this list of conditions and the following disclaimer in the
13 # documentation and/or other materials provided with the distribution.
15 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 # ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 ############################################################ INCLUDES
31 BSDCFG_SHARE="/usr/share/bsdconfig"
32 . $BSDCFG_SHARE/common.subr || exit 1
33 f_dprintf "%s: loading includes..." media/http.subr
34 f_include $BSDCFG_SHARE/device.subr
35 f_include $BSDCFG_SHARE/dialog.subr
36 f_include $BSDCFG_SHARE/media/common.subr
37 f_include $BSDCFG_SHARE/media/tcpip.subr
38 f_include $BSDCFG_SHARE/strings.subr
39 f_include $BSDCFG_SHARE/struct.subr
40 f_include $BSDCFG_SHARE/variable.subr
42 BSDCFG_LIBE="/usr/libexec/bsdconfig"
43 f_include_lang $BSDCFG_LIBE/include/messages.subr
45 ############################################################ GLOBALS
50 # NOTE: This is according to actual fetch(1) test-results. We actually
51 # use nc(1) to retrieve files, but it's still a good idea to keep the
52 # URLs short enough that fetch(1) won't complain.
59 pub/FreeBSD/releases/$UNAME_P
60 pub/FreeBSD/snapshots/$UNAME_P
61 pub/FreeBSD-Archive/old-releases/$UNAME_P
64 ############################################################ FUNCTIONS
66 # f_dialog_menu_media_http
68 # Prompt the user to select from a range of ``built-in'' HTTP servers or
69 # specify their own. If the user makes a choice and doesn't cancel or press
70 # Esc, stores the user's choice in VAR_FTP_PATH (see variable.subr) and returns
73 f_dialog_menu_media_http()
75 f_dialog_title "$msg_please_select_a_freebsd_http_distribution_site"
76 local title="$DIALOG_TITLE" btitle="$DIALOG_BACKTITLE"
77 f_dialog_title_restore
78 local prompt="$msg_please_select_the_site_closest_to_you_or_other"
80 '$msg_main_site' 'ftp.freebsd.org'
81 'URL' '$msg_specify_some_other_http_site'
83 local hline="$msg_select_a_site_thats_close"
85 local height width rows
86 eval f_dialog_menu_size height width rows \
94 mtag=$( eval $DIALOG \
96 --backtitle \"\$btitle\" \
98 --ok-label \"\$msg_ok\" \
99 --cancel-label \"\$msg_cancel\" \
100 --menu \"\$prompt\" \
101 $height $width $rows \
103 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
104 ) || return $DIALOG_CANCEL
105 f_dialog_data_sanitize mtag
108 URL) setvar $VAR_HTTP_PATH "other" ;;
111 value=$( eval f_dialog_menutag2item \"\$mtag\" $menu_list )
112 setvar $VAR_HTTP_PATH "http://$value"
120 # Return success if we both found and set the media type to be an HTTP server.
122 # Variables from variable.subr that can be used to script user input:
125 # URL containing host and optionally a target path to the release
126 # repository on the HTTP server. Valid examples include:
128 # http://somename:80/pub/
129 # http://192.168.2.3/pub/
131 # The default port if not specified is 80.
132 # VAR_NAMESERVER [Optional]
133 # If set, overrides resolv.conf(5) and sets the nameserver that
134 # is used to convert names into addresses (when a name converts
135 # into multiple addresses, the first address to successfully
138 # Meanwhile, the following variables from variable.subr are set after
139 # successful execution:
142 # The HTTP host to connect to, parsed from VAR_HTTP_PATH. In the
143 # example case of IPv6 where VAR_HTTP_PATH is "http://[::1]" this
144 # variable will be set to "::1" (the outer brackets are removed).
146 # The TCP port to connect to, parsed from VAR_HTTP_PATH. Usually
147 # 80 unless VAR_HTTP_PATH was one of the following forms:
148 # http://hostname:OTHER_PORT
149 # http://hostname:OTHER_PORT/*
150 # http://ip:OTHER_PORT
151 # http://ip:OTHER_PORT/*
152 # http://[ip6]:OTHER_PORT
153 # http://[ip6]:OTHER_PORT/*
155 # If VAR_HTTP_PATH contained a directory element (e.g.,
156 # "http://localhost/pub") this variable contains only the
157 # directory element (e.g., "/pub").
164 f_getvar $VAR_HTTP_PATH url
166 # If we've been through here before ...
167 if f_struct device_network && [ "${url#$msg_other}" ]; then
168 f_dialog_yesno "$msg_reuse_old_http_site_settings" || url=
171 if [ ! "$url" ]; then
172 f_dialog_menu_media_http || return $FAILURE
173 f_getvar $VAR_HTTP_PATH url
175 [ "$url" ] || return $FAILURE
179 setvar $VAR_HTTP_PATH "http://"
180 f_variable_get_value $VAR_HTTP_PATH \
181 "$msg_please_specify_url_of_freebsd_http_distribution"
182 f_getvar $VAR_HTTP_PATH url
183 if [ ! "${url#http://}" ]; then
187 if [ ${#url} -gt ${URL_MAX:-261261} ]; then
188 f_show_msg "$msg_length_of_specified_url_is_too_long" \
189 ${#url} ${URL_MAX:-261261}
194 http://*) : valid URL ;;
196 f_show_msg "$msg_sorry_invalid_url" "$url"
202 http://*) : valid URL ;;
204 f_show_msg "$msg_sorry_invalid_url" "$url"
209 # Set the name of the HTTP device to the URL
210 f_struct_new DEVICE device_http
211 device_http set name "$url"
213 if ! f_struct device_network ||
214 ! f_dialog_yesno "$msg_youve_already_done_the_network_configuration"
216 f_struct device_network &&
217 f_device_shutdown network
218 if ! f_device_select_tcp; then
223 f_getvar $VAR_NETWORK_DEVICE dev
224 f_struct_copy "device_$dev" device_network
226 if ! f_device_init network; then
227 f_dprintf "f_media_set_http: %s" "$msg_net_device_init_failed"
232 local hostname="${url#*://}" port=80 dir=/
235 # The order in-which the below individual cases appear is important!
237 "["*"]":*/*) # IPv6 address with port and directory
238 f_dprintf "Looks like an IPv6 addr with port/dir: %s" \
240 hostname="${hostname#\[}"
241 port="${hostname#*\]:}"
242 port="${port%%[!0-9]*}"
243 dir="/${hostname#*/}"
244 hostname="${hostname%%\]:*}"
246 "["*"]":*) # IPv6 address with port
247 f_dprintf "Looks like an IPv6 addr with port: %s" "$hostname"
248 hostname="${hostname#\[}"
249 port="${hostname#*\]:}"
250 port="${port%%[!0-9]*}"
251 hostname="${hostname%%\]:*}"
253 "["*"]"/*) # IPv6 address with directory
254 f_dprintf "Looks like an IPv6 addr with dir: %s" "$hostname"
255 hostname="${hostname#\[}"
256 dir="/${hostname#*/}"
257 hostname="${hostname%%\]*}"
259 "["*"]") # IPv6 address
260 f_dprintf "Looks like an IPv6 addr: %s" "$hostname"
261 hostname="${hostname#\[}"
262 hostname="${hostname%\]}"
265 # ^^^ IPv6 above / DNS Name or IPv4 below vvv
267 *:*/*) # DNS name or IPv4 address with port and directory
268 f_dprintf "Looks like a %s with port/dir: %s" \
269 "DNS name or IPv4 addr" "$hostname"
270 port="${hostname#*:}"
271 port="${port%%[!0-9]*}"
272 dir="/${hostname#*/}"
273 hostname="${hostname%%:*}"
275 *:*) # DNS name or IPv4 address with port
276 f_dprintf "Looks like a DNS name or IPv4 addr with port: %s" \
278 port="${hostname#*:}"
279 hostname="${hostname%%:*}"
281 */*) # DNS name or IPv4 address with directory
282 f_dprintf "Looks like a DNS name or IPv4 addr with dir: %s" \
284 dir="/${hostname#*/}"
285 hostname="${hostname%%/*}"
287 *) # DNS name or IPv4 address
288 f_dprintf "Looks like a DNS name or IPv4 addr: %s" "$hostname"
289 : leave hostname as-is
292 f_dprintf "hostname = \`%s'" "$hostname"
293 f_dprintf "dir = \`%s'" "$dir"
294 f_dprintf "port \# = \`%d'" "$port"
297 f_getvar $VAR_NAMESERVER ns
298 [ "$ns" ] || f_resolv_conf_nameservers ns
299 if [ "$ns" -a ! "$HTTP_SKIP_RESOLV" ] && ! {
300 f_validate_ipaddr "$hostname" ||
301 f_validate_ipaddr6 "$hostname"
303 f_show_info "$msg_looking_up_host" "$hostname"
304 f_dprintf "%s: Looking up hostname, %s, using host(1)" \
305 "f_media_set_http" "$hostname"
306 if ! f_quietly f_host_lookup "$hostname"; then
307 f_show_msg "$msg_cannot_resolve_hostname" "$hostname"
308 f_struct device_network &&
309 f_device_shutdown network
310 f_struct_free device_network
314 f_dprintf "Found DNS entry for %s successfully." "$hostname"
317 setvar $VAR_HTTP_HOST "$hostname"
318 setvar $VAR_HTTP_PORT "$port"
319 setvar $VAR_HTTP_DIR "$dir"
321 device_http set type $DEVICE_TYPE_HTTP
322 device_http set init f_media_init_http
323 device_http set get f_media_get_http
324 device_http set shutdown f_media_shutdown_http
325 device_http set private network
326 f_struct_copy device_http device_media
327 f_struct_free device_http
332 # f_http_check_access [$connect_only]
334 # Return success if able list a remote HTTP directory. If $connect_only is
335 # present and non-null, then returns success if a connection can be made.
336 # Variables from variable.subr that can be used to script user input:
339 # The HTTP server host name, IPv4 address or IPv6 address.
340 # Valid examples include:
345 # The TCP port to connect to when communicating with the server.
347 # The HTTP path sent to the server. Unused if $connect_only is
348 # present and non-NULL.
350 f_http_check_access()
352 local connect_only="$1" hosts=
354 local http_host http_port
355 f_getvar $VAR_HTTP_HOST http_host
356 f_getvar $VAR_HTTP_PORT http_port
359 f_validate_ipaddr "$http_host" ||
360 f_validate_ipaddr6 "$http_host" ||
362 f_dprintf "%s: Looking up hostname, %s, using host(1)" \
363 "f_http_check_access" "$http_host"
364 f_host_lookup "$http_host" hosts
367 # All the above validations failed
368 [ "$hosts" ] && f_dialog_msgbox "$hosts"
371 elif [ ! "$hosts" ]; then
372 # One of the first two validations passed
376 local host connected=
377 for host in $hosts; do
378 f_quietly nc -nz "$host" "$http_port" || continue
381 if [ ! "$connected" ]; then
382 f_show_msg "$msg_couldnt_connect_to_server http://%s:%s/" \
383 "$http_host" "$http_port"
387 [ "$connect_only" ] && return $SUCCESS
390 f_getvar $VAR_HTTP_PATH http_path
391 f_show_info "$msg_checking_access_to" "$http_path"
395 http://*|/*) : valid request ;;
396 *) http_path="/$http_path" # full URI requests only
399 printf "GET %s/ HTTP/1.0\r\n\r\n" "${http_path%/}" |
400 nc -n "$host" "$http_port"
402 f_show_msg "$msg_couldnt_connect_to_server http://%s:%s/" \
403 "$http_host" "$http_port"
409 hdr=$( echo "$rx" | awk '/^\r$/{exit}{print}' )
411 local http_found=$FAILURE
412 if echo "$hdr" | awk '
426 # f_media_init_http $device
428 # Initializes the HTTP media device. Returns success if able to confirm the
429 # existence of at least one known HTTP server release path directly via HTTP
430 # using f_http_check_access(), above.
432 # Variables from variable.subr that can be used to script user input:
435 # The HTTP server to connect to. Must be set. Also see
436 # f_http_check_access() for additional variables.
438 # Usually set to `uname -r' but can be overridden.
440 # The HTTP path sent to the server. Usually set by calling
441 # f_media_set_http().
443 # Meanwhile, after successful execution, the following variables (also from
444 # variable.subr) are set:
447 # The [possibly] adjusted VAR_HTTP_PATH that was found to contain
448 # a valid FreeBSD repository.
453 f_dprintf "Init routine called for HTTP device. dev=[%s]" "$dev"
456 # First verify access
459 f_http_check_access $connect_only
462 f_getvar $VAR_HTTP_HOST http_host
463 while [ ! "$http_host" ]; do
464 f_media_set_http || return $FAILURE
465 f_http_check_access $connect_only
466 f_getvar $VAR_HTTP_HOST http_host
469 local http_path http_found=$FAILURE
472 # Now that we've verified that the path we're given is ok,
473 # let's try to be a bit intelligent in locating the release we
474 # are looking for. First off, if the release is specified as
475 # "__RELEASE" or "any", then just assume that the current
476 # directory is the one we want and give up.
479 f_getvar $VAR_RELNAME rel
480 f_dprintf "f_media_init_http: rel=[%s]" "$rel"
484 setvar $VAR_HTTP_PATH "$VAR_HTTP_DIR"
490 # Ok, since we have a release variable, let's walk
491 # through the list of directories looking for a release
492 # directory. First successful path wins.
495 f_getvar $VAR_HTTP_PATH%/ hp
496 for fdir in $HTTP_DIRS; do
497 setvar $VAR_HTTP_PATH "$hp/$fdir/$rel"
498 if f_http_check_access; then
505 [ $http_found -eq $SUCCESS ] && break
507 f_getvar $VAR_HTTP_PATH http_path
508 f_show_msg "$msg_please_check_the_url_and_try_again" \
512 f_media_set_http || break
518 # f_media_get_http $device $file [$probe_type]
520 # Returns data from $file on an HTTP server using nc(1). Please note that
521 # $device is unused but must be present (even if null). Information is instead
522 # gathered from the environment. If $probe_type is both present and non-NULL,
523 # this function exits after receiving the HTTP header response from the server
524 # (if the HTTP response code is 200, success is returned; otherwise failure).
525 # If $probe_type is equal to $PROBE_SIZE, prints the content-length in bytes
526 # from the response (or -1 if not found) to standard-out.
528 # The variables used to configure the connection are as follows (all of which
529 # are configured by f_media_set_http above):
532 # HTTP server which to connect. Can be an IPv4 address, IPv6
533 # address, or DNS hostname of your choice.
535 # TCP port to connect on; see f_media_set_http above.
537 # Directory prefix to use when requesting $file. Default is `/'
538 # unless f_media_init_http was able to use f_http_check_access
539 # to validate one of the defaults in $HTTP_DIRS (see GLOBALS at
540 # the top of this file); assuming VAR_RELNAME was not set to
541 # either `__RELEASE' or `any' (indicating that the global set of
542 # $HTTP_DIRS should be ignored).
544 # See variable.subr for additional information.
548 # f_media_get_http media $file
552 local dev="$1" file="$2" probe_type="$3" hosts=
554 f_dprintf "f_media_get_http: dev=[%s] file=[%s] probe_type=%s" \
555 "$dev" "$file" "$probe_type"
557 local http_host http_port
558 f_getvar $VAR_HTTP_HOST http_host
559 f_getvar $VAR_HTTP_PORT http_port
562 f_validate_ipaddr "$http_host" ||
563 f_validate_ipaddr6 "$http_host" ||
565 f_dprintf "%s: Looking up hostname, %s, using host(1)" \
566 "f_media_get_http" "$http_host"
567 f_host_lookup "$http_host" hosts
570 # All the above validations failed
571 [ "$hosts" ] && f_dialog_msgbox "$hosts"
573 elif [ ! "$hosts" ]; then
574 # One of the first two validations passed
578 local host connected=
579 for host in $hosts; do
580 f_quietly nc -nz "$host" "$http_port" || continue
583 if [ ! "$connected" ]; then
584 f_show_msg "$msg_couldnt_connect_to_server http://%s:%s/" \
585 "$http_host" "$http_port"
590 f_getvar $VAR_HTTP_PATH%/ http_path
592 http://*|/*) : valid request ;;
593 *) http_path="/$http_path" # full URI requests only
596 local url="$http_path/$file" rx
597 f_dprintf "sending http request for: %s" "$url"
598 printf "GET %s HTTP/1.0\r\n\r\n" "$url" | nc -n "$host" "$http_port" |
601 # scan the headers of the response
602 # this is extremely quick'n dirty
609 f_dprintf "received response: %s" "$LINE"
611 f_isinteger "$rv" || rv=0
615 length="${length#Content-Length: }"
616 f_dprintf "received content-length: %s" \
620 [ "${LINE%
\r}" ] || break # End of headers
624 [ $rv -ge 500 ] && exit 5
625 [ $rv -eq 404 ] && exit 44
626 [ $rv -ge 400 ] && exit 4
627 [ $rv -ge 300 ] && exit 3
628 [ $rv -eq 200 ] || exit $FAILURE
630 if [ ! "$probe_type" ]; then
631 cat # output the rest ``as-is''
632 elif [ "$probe_type" = "$PROBE_SIZE" ]; then
633 f_isinteger "$length" || length=-1
639 [ $retval -eq 200 ] && return $SUCCESS
640 [ "$probe_type" ] && return $FAILURE
643 5) f_show_msg "$msg_server_error_when_requesting_url" "$url" ;;
644 44) f_show_msg "$msg_url_was_not_found" "$url" ;;
645 4) f_show_msg "$msg_client_error" ;;
646 *) f_show_msg "$msg_error_when_requesting_url" "$url" ;;
651 ############################################################ MAIN
653 f_dprintf "%s: Successfully loaded." media/http.subr
655 fi # ! $_MEDIA_HTTP_SUBR