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 'dist $msg_main_site' 'ftp.freebsd.org'
81 'pkg $msg_main_site' 'pkg.freebsd.org'
82 'URL' '$msg_specify_some_other_http_site'
84 local hline="$msg_select_a_site_thats_close"
86 local height width rows
87 eval f_dialog_menu_size height width rows \
95 mtag=$( eval $DIALOG \
97 --backtitle \"\$btitle\" \
99 --ok-label \"\$msg_ok\" \
100 --cancel-label \"\$msg_cancel\" \
101 --menu \"\$prompt\" \
102 $height $width $rows \
104 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
105 ) || return $DIALOG_CANCEL
106 f_dialog_data_sanitize mtag
109 URL) setvar $VAR_HTTP_PATH "other" ;;
112 value=$( eval f_dialog_menutag2item \"\$mtag\" $menu_list )
113 setvar $VAR_HTTP_PATH "http://$value"
121 # Return success if we both found and set the media type to be an HTTP server.
123 # Variables from variable.subr that can be used to script user input:
126 # URL containing host and optionally a target path to the release
127 # repository on the HTTP server. Valid examples include:
129 # http://somename:80/pub/
130 # http://192.168.2.3/pub/
132 # The default port if not specified is 80.
133 # VAR_NAMESERVER [Optional]
134 # If set, overrides resolv.conf(5) and sets the nameserver that
135 # is used to convert names into addresses (when a name converts
136 # into multiple addresses, the first address to successfully
139 # Meanwhile, the following variables from variable.subr are set after
140 # successful execution:
143 # The HTTP host to connect to, parsed from VAR_HTTP_PATH. In the
144 # example case of IPv6 where VAR_HTTP_PATH is "http://[::1]" this
145 # variable will be set to "::1" (the outer brackets are removed).
147 # The TCP port to connect to, parsed from VAR_HTTP_PATH. Usually
148 # 80 unless VAR_HTTP_PATH was one of the following forms:
149 # http://hostname:OTHER_PORT
150 # http://hostname:OTHER_PORT/*
151 # http://ip:OTHER_PORT
152 # http://ip:OTHER_PORT/*
153 # http://[ip6]:OTHER_PORT
154 # http://[ip6]:OTHER_PORT/*
156 # If VAR_HTTP_PATH contained a directory element (e.g.,
157 # "http://localhost/pub") this variable contains only the
158 # directory element (e.g., "/pub").
165 f_getvar $VAR_HTTP_PATH url
167 # If we've been through here before ...
168 if f_struct device_network && [ "${url#$msg_other}" ]; then
169 f_dialog_yesno "$msg_reuse_old_http_site_settings" || url=
172 if [ ! "$url" ]; then
173 f_dialog_menu_media_http || return $FAILURE
174 f_getvar $VAR_HTTP_PATH url
176 [ "$url" ] || return $FAILURE
180 setvar $VAR_HTTP_PATH "http://"
181 f_variable_get_value $VAR_HTTP_PATH \
182 "$msg_please_specify_url_of_freebsd_http_distribution"
183 f_getvar $VAR_HTTP_PATH url
184 if [ ! "${url#http://}" ]; then
188 if [ ${#url} -gt ${URL_MAX:-261261} ]; then
189 f_show_msg "$msg_length_of_specified_url_is_too_long" \
190 ${#url} ${URL_MAX:-261261}
195 http://*) : valid URL ;;
197 f_show_msg "$msg_sorry_invalid_url" "$url"
203 http://*) : valid URL ;;
205 f_show_msg "$msg_sorry_invalid_url" "$url"
210 # Set the name of the HTTP device to the URL
211 f_struct_new DEVICE device_http
212 device_http set name "$url"
214 if ! f_struct device_network ||
215 ! f_dialog_yesno "$msg_youve_already_done_the_network_configuration"
217 f_struct device_network &&
218 f_device_shutdown network
219 if ! f_device_select_tcp; then
224 f_getvar $VAR_NETWORK_DEVICE dev
225 f_struct_copy "device_$dev" device_network
227 if ! f_device_init network; then
228 f_dprintf "f_media_set_http: %s" "$msg_net_device_init_failed"
233 local hostname="${url#*://}" port=80 dir=/
236 # The order in-which the below individual cases appear is important!
238 "["*"]":*/*) # IPv6 address with port and directory
239 f_dprintf "Looks like an IPv6 addr with port/dir: %s" \
241 hostname="${hostname#\[}"
242 port="${hostname#*\]:}"
243 port="${port%%[!0-9]*}"
244 dir="/${hostname#*/}"
245 hostname="${hostname%%\]:*}"
247 "["*"]":*) # IPv6 address with port
248 f_dprintf "Looks like an IPv6 addr with port: %s" "$hostname"
249 hostname="${hostname#\[}"
250 port="${hostname#*\]:}"
251 port="${port%%[!0-9]*}"
252 hostname="${hostname%%\]:*}"
254 "["*"]"/*) # IPv6 address with directory
255 f_dprintf "Looks like an IPv6 addr with dir: %s" "$hostname"
256 hostname="${hostname#\[}"
257 dir="/${hostname#*/}"
258 hostname="${hostname%%\]*}"
260 "["*"]") # IPv6 address
261 f_dprintf "Looks like an IPv6 addr: %s" "$hostname"
262 hostname="${hostname#\[}"
263 hostname="${hostname%\]}"
266 # ^^^ IPv6 above / DNS Name or IPv4 below vvv
268 *:*/*) # DNS name or IPv4 address with port and directory
269 f_dprintf "Looks like a %s with port/dir: %s" \
270 "DNS name or IPv4 addr" "$hostname"
271 port="${hostname#*:}"
272 port="${port%%[!0-9]*}"
273 dir="/${hostname#*/}"
274 hostname="${hostname%%:*}"
276 *:*) # DNS name or IPv4 address with port
277 f_dprintf "Looks like a DNS name or IPv4 addr with port: %s" \
279 port="${hostname#*:}"
280 hostname="${hostname%%:*}"
282 */*) # DNS name or IPv4 address with directory
283 f_dprintf "Looks like a DNS name or IPv4 addr with dir: %s" \
285 dir="/${hostname#*/}"
286 hostname="${hostname%%/*}"
288 *) # DNS name or IPv4 address
289 f_dprintf "Looks like a DNS name or IPv4 addr: %s" "$hostname"
290 : leave hostname as-is
293 f_dprintf "hostname = \`%s'" "$hostname"
294 f_dprintf "dir = \`%s'" "$dir"
295 f_dprintf "port \# = \`%d'" "$port"
298 f_getvar $VAR_NAMESERVER ns
299 [ "$ns" ] || f_resolv_conf_nameservers ns
300 if [ "$ns" -a ! "$HTTP_SKIP_RESOLV" ] && ! {
301 f_validate_ipaddr "$hostname" ||
302 f_validate_ipaddr6 "$hostname"
304 f_show_info "$msg_looking_up_host" "$hostname"
305 f_dprintf "%s: Looking up hostname, %s, using host(1)" \
306 "f_media_set_http" "$hostname"
307 if ! f_quietly f_host_lookup "$hostname"; then
308 f_show_msg "$msg_cannot_resolve_hostname" "$hostname"
309 f_struct device_network &&
310 f_device_shutdown network
311 f_struct_free device_network
315 f_dprintf "Found DNS entry for %s successfully." "$hostname"
318 setvar $VAR_HTTP_HOST "$hostname"
319 setvar $VAR_HTTP_PORT "$port"
320 setvar $VAR_HTTP_DIR "$dir"
322 device_http set type $DEVICE_TYPE_HTTP
323 device_http set init f_media_init_http
324 device_http set get f_media_get_http
325 device_http set shutdown f_media_shutdown_http
326 device_http set private network
327 f_struct_copy device_http device_media
328 f_struct_free device_http
333 # f_http_check_access [$connect_only]
335 # Return success if able list a remote HTTP directory. If $connect_only is
336 # present and non-null, then returns success if a connection can be made.
337 # Variables from variable.subr that can be used to script user input:
340 # The HTTP server host name, IPv4 address or IPv6 address.
341 # Valid examples include:
346 # The TCP port to connect to when communicating with the server.
348 # The HTTP path sent to the server. Unused if $connect_only is
349 # present and non-NULL.
351 f_http_check_access()
353 local connect_only="$1" hosts=
355 local http_host http_port
356 f_getvar $VAR_HTTP_HOST http_host
357 f_getvar $VAR_HTTP_PORT http_port
360 f_validate_ipaddr "$http_host" ||
361 f_validate_ipaddr6 "$http_host" ||
363 f_dprintf "%s: Looking up hostname, %s, using host(1)" \
364 "f_http_check_access" "$http_host"
365 f_host_lookup "$http_host" hosts
368 # All the above validations failed
369 [ "$hosts" ] && f_dialog_msgbox "$hosts"
372 elif [ ! "$hosts" ]; then
373 # One of the first two validations passed
377 local host connected=
378 for host in $hosts; do
379 f_quietly nc -nz "$host" "$http_port" || continue
382 if [ ! "$connected" ]; then
383 f_show_msg "$msg_couldnt_connect_to_server http://%s:%s/" \
384 "$http_host" "$http_port"
388 [ "$connect_only" ] && return $SUCCESS
391 f_getvar $VAR_HTTP_PATH http_path
392 f_show_info "$msg_checking_access_to" "$http_path"
396 http://*|/*) : valid request ;;
397 *) http_path="/$http_path" # full URI requests only
400 printf "GET %s/ HTTP/1.0\r\n\r\n" "${http_path%/}" |
401 nc -n "$host" "$http_port"
403 f_show_msg "$msg_couldnt_connect_to_server http://%s:%s/" \
404 "$http_host" "$http_port"
410 hdr=$( echo "$rx" | awk '/^\r$/{exit}{print}' )
412 local http_found=$FAILURE
413 if echo "$hdr" | awk '
427 # f_media_init_http $device
429 # Initializes the HTTP media device. Returns success if able to confirm the
430 # existence of at least one known HTTP server release path directly via HTTP
431 # using f_http_check_access(), above.
433 # Variables from variable.subr that can be used to script user input:
436 # The HTTP server to connect to. Must be set. Also see
437 # f_http_check_access() for additional variables.
439 # Usually set to `uname -r' but can be overridden.
441 # The HTTP path sent to the server. Usually set by calling
442 # f_media_set_http().
444 # Meanwhile, after successful execution, the following variables (also from
445 # variable.subr) are set:
448 # The [possibly] adjusted VAR_HTTP_PATH that was found to contain
449 # a valid FreeBSD repository.
454 f_dprintf "Init routine called for HTTP device. dev=[%s]" "$dev"
456 if [ "$HTTP_INITIALIZED" ]; then
457 f_dprintf "HTTP device already initialized."
462 # First verify access
465 f_http_check_access $connect_only
468 f_getvar $VAR_HTTP_HOST http_host
469 while [ ! "$http_host" ]; do
470 f_media_set_http || return $FAILURE
471 f_http_check_access $connect_only
472 f_getvar $VAR_HTTP_HOST http_host
475 local http_path http_found=$FAILURE
478 # Now that we've verified that the path we're given is ok,
479 # let's try to be a bit intelligent in locating the release we
480 # are looking for. First off, if the release is specified as
481 # "__RELEASE" or "any", then just assume that the current
482 # directory is the one we want and give up.
485 f_getvar $VAR_RELNAME rel
486 f_dprintf "f_media_init_http: rel=[%s]" "$rel"
490 f_getvar $VAR_HTTP_DIR $VAR_HTTP_PATH
496 # Ok, since we have a release variable, let's walk
497 # through the list of directories looking for a release
498 # directory. First successful path wins.
501 f_getvar $VAR_HTTP_PATH%/ hp
502 setvar $VAR_HTTP_PATH "$hp/$PKG_ABI/latest"
503 if [ "$PKG_ABI" ] && f_http_check_access; then
505 setvar $VAR_HTTP_PATH "$hp"
507 for fdir in $HTTP_DIRS; do
508 setvar $VAR_HTTP_PATH "$hp/$fdir/$rel"
509 if f_http_check_access; then
517 if [ $http_found -eq $SUCCESS ]; then
522 f_getvar $VAR_HTTP_PATH http_path
523 f_show_msg "$msg_please_check_the_url_and_try_again" \
526 unset HTTP_INITIALIZED $VAR_HTTP_PATH
527 f_media_set_http || break
533 # f_media_get_http $device $file [$probe_type]
535 # Returns data from $file on an HTTP server using nc(1). Please note that
536 # $device is unused but must be present (even if null). Information is instead
537 # gathered from the environment. If $probe_type is both present and non-NULL,
538 # this function exits after receiving the HTTP header response from the server
539 # (if the HTTP response code is 200, success is returned; otherwise failure).
540 # If $probe_type is equal to $PROBE_SIZE, prints the content-length in bytes
541 # from the response (or -1 if not found) to standard-out.
543 # The variables used to configure the connection are as follows (all of which
544 # are configured by f_media_set_http above):
547 # HTTP server which to connect. Can be an IPv4 address, IPv6
548 # address, or DNS hostname of your choice.
550 # TCP port to connect on; see f_media_set_http above.
552 # Directory prefix to use when requesting $file. Default is `/'
553 # unless f_media_init_http was able to use f_http_check_access
554 # to validate one of the defaults in $HTTP_DIRS (see GLOBALS at
555 # the top of this file); assuming VAR_RELNAME was not set to
556 # either `__RELEASE' or `any' (indicating that the global set of
557 # $HTTP_DIRS should be ignored).
559 # See variable.subr for additional information.
563 # f_media_get_http media $file
567 local dev="$1" file="$2" probe_type="$3" hosts=
569 f_dprintf "f_media_get_http: dev=[%s] file=[%s] probe_type=%s" \
570 "$dev" "$file" "$probe_type"
572 local http_host http_port
573 f_getvar $VAR_HTTP_HOST http_host
574 f_getvar $VAR_HTTP_PORT http_port
576 if [ ! "$HTTP_INITIALIZED" ]; then
577 f_dprintf "No HTTP connection open, can't get file %s" "$file"
582 f_validate_ipaddr "$http_host" ||
583 f_validate_ipaddr6 "$http_host" ||
585 f_dprintf "%s: Looking up hostname, %s, using host(1)" \
586 "f_media_get_http" "$http_host"
587 f_host_lookup "$http_host" hosts
590 # All the above validations failed
591 [ "$hosts" ] && f_dialog_msgbox "$hosts"
593 elif [ ! "$hosts" ]; then
594 # One of the first two validations passed
598 local host connected=
599 for host in $hosts; do
600 f_quietly nc -nz "$host" "$http_port" || continue
603 if [ ! "$connected" ]; then
604 f_show_msg "$msg_couldnt_connect_to_server http://%s:%s/" \
605 "$http_host" "$http_port"
610 f_getvar $VAR_HTTP_PATH%/ http_path
612 http://*|/*) : valid request ;;
613 *) http_path="/$http_path" # full URI requests only
616 local url="$http_path/$file" rx
617 f_dprintf "sending http request for: %s" "$url"
618 f_dprintf "using nc to connect to: %s:%s" "$host" "$http_port"
619 printf "GET %s HTTP/1.0\r\n\r\n" "$url" | nc -n "$host" "$http_port" |
622 # scan the headers of the response
623 # this is extremely quick'n dirty
630 f_dprintf "received response: %s" "$LINE"
632 f_isinteger "$rv" || rv=0
636 length="${length#Content-Length: }"
637 f_dprintf "received content-length: %s" \
641 [ "${LINE%
\r}" ] || break # End of headers
645 [ $rv -ge 500 ] && exit 5
646 [ $rv -eq 404 ] && exit 44
647 [ $rv -ge 400 ] && exit 4
648 [ $rv -ge 300 ] && exit 3
649 [ $rv -eq 200 ] || exit $FAILURE
651 if [ ! "$probe_type" ]; then
652 cat # output the rest ``as-is''
653 elif [ "$probe_type" = "$PROBE_SIZE" ]; then
654 f_isinteger "$length" || length=-1
660 [ $retval -eq 200 ] && return $SUCCESS
661 [ "$probe_type" ] && return $FAILURE
664 5) f_show_msg "$msg_server_error_when_requesting_url" "$url" ;;
665 44) f_show_msg "$msg_url_was_not_found" "$url" ;;
666 4) f_show_msg "$msg_client_error" ;;
667 *) f_show_msg "$msg_error_when_requesting_url" "$url" ;;
672 # f_media_shutdown_http $device
674 # Shuts down the HTTP device. Return status should be ignored. Note that since
675 # we don't maintain an open connection to the HTTP server, nothing to do.
677 f_media_shutdown_http()
679 [ "$HTTP_INITIALIZED" ] || return $SUCCESS
681 unset HTTP_INITIALIZED
684 ############################################################ MAIN
686 f_dprintf "%s: Successfully loaded." media/http.subr
688 fi # ! $_MEDIA_HTTP_SUBR