ftp.subr revision 255908
1if [ ! "$_MEDIA_FTP_SUBR" ]; then _MEDIA_FTP_SUBR=1 2# 3# Copyright (c) 2012-2013 Devin Teske 4# All rights reserved. 5# 6# Redistribution and use in source and binary forms, with or without 7# modification, are permitted provided that the following conditions 8# are met: 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. 14# 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 25# SUCH DAMAGE. 26# 27# $FreeBSD: head/usr.sbin/bsdconfig/share/media/ftp.subr 255908 2013-09-27 11:25:37Z brd $ 28# 29############################################################ INCLUDES 30 31BSDCFG_SHARE="/usr/share/bsdconfig" 32. $BSDCFG_SHARE/common.subr || exit 1 33f_dprintf "%s: loading includes..." media/ftp.subr 34f_include $BSDCFG_SHARE/device.subr 35f_include $BSDCFG_SHARE/dialog.subr 36f_include $BSDCFG_SHARE/media/common.subr 37f_include $BSDCFG_SHARE/media/tcpip.subr 38f_include $BSDCFG_SHARE/strings.subr 39f_include $BSDCFG_SHARE/struct.subr 40f_include $BSDCFG_SHARE/variable.subr 41 42BSDCFG_LIBE="/usr/libexec/bsdconfig" 43f_include_lang $BSDCFG_LIBE/include/messages.subr 44 45############################################################ GLOBALS 46 47FTP_SKIP_RESOLV= 48 49URL_MAX=261261 # according to actual fetch(1) test-results 50 51FTP_DIRS=" 52 . 53 releases/$UNAME_P 54 snapshots/$UNAME_P 55 pub/FreeBSD 56 pub/FreeBSD/releases/$UNAME_P 57 pub/FreeBSD/snapshots/$UNAME_P 58 pub/FreeBSD-Archive/old-releases/$UNAME_P 59" # END-QUOTE 60 61############################################################ FUNCTIONS 62 63# f_dialog_menu_media_ftp 64# 65# Prompt the user to select from a range of ``built-in'' FTP servers or specify 66# their own. If the user makes a choice and doesn't cancel or press Esc, stores 67# the user's choice in VAR_FTP_PATH (see variables.subr) and returns success. 68# 69f_dialog_menu_media_ftp() 70{ 71 f_dialog_title "$msg_please_select_a_freebsd_ftp_distribution_site" 72 local title="$DIALOG_TITLE" btitle="$DIALOG_BACKTITLE" 73 f_dialog_title_restore 74 local prompt="$msg_please_select_the_site_closest_to_you_or_other" 75 local menu_list=" 76 '$msg_main_site' 'ftp.freebsd.org' 77 'URL' '$msg_specify_some_other_ftp_site' 78 'IPv6 $msg_main_site' 'ftp.freebsd.org' 79 ' IPv6 $msg_france' 'ftp4.fr.freebsd.org' 80 ' IPv6 $msg_france #8' 'ftp8.fr.freebsd.org' 81 ' IPv6 $msg_ireland' 'ftp3.ie.freebsd.org' 82 ' IPv6 $msg_japan' 'ftp2.jp.freebsd.org' 83 ' IPv6 $msg_sweden' 'ftp4.se.freebsd.org' 84 ' IPv6 $msg_usa' 'ftp4.us.freebsd.org' 85 ' IPv6 $msg_turkey' 'ftp2.tr.freebsd.org' 86 '$msg_primary' 'ftp1.freebsd.org' 87 ' $msg_primary #2' 'ftp2.freebsd.org' 88 ' $msg_primary #3' 'ftp3.freebsd.org' 89 ' $msg_primary #4' 'ftp4.freebsd.org' 90 ' $msg_primary #5' 'ftp5.freebsd.org' 91 ' $msg_primary #6' 'ftp6.freebsd.org' 92 ' $msg_primary #7' 'ftp7.freebsd.org' 93 ' $msg_primary #10' 'ftp10.freebsd.org' 94 ' $msg_primary #11' 'ftp11.freebsd.org' 95 ' $msg_primary #12' 'ftp12.freebsd.org' 96 ' $msg_primary #13' 'ftp13.freebsd.org' 97 ' $msg_primary #14' 'ftp14.freebsd.org' 98 '$msg_armenia' 'ftp1.am.freebsd.org' 99 '$msg_australia' 'ftp.au.freebsd.org' 100 ' $msg_australia #2' 'ftp2.au.freebsd.org' 101 ' $msg_australia #3' 'ftp3.au.freebsd.org' 102 '$msg_austria' 'ftp.at.freebsd.org' 103 '$msg_brazil' 'ftp2.br.freebsd.org' 104 ' $msg_brazil #3' 'ftp3.br.freebsd.org' 105 ' $msg_brazil #4' 'ftp4.br.freebsd.org' 106 '$msg_canada' 'ftp.ca.freebsd.org' 107 '$msg_china' 'ftp.cn.freebsd.org' 108 '$msg_czech_republic' 'ftp.cz.freebsd.org' 109 '$msg_denmark' 'ftp.dk.freebsd.org' 110 '$msg_estonia' 'ftp.ee.freebsd.org' 111 '$msg_finland' 'ftp.fi.freebsd.org' 112 '$msg_france' 'ftp.fr.freebsd.org' 113 ' $msg_france #3' 'ftp3.fr.freebsd.org' 114 ' $msg_france #4' 'ftp4.fr.freebsd.org' 115 ' $msg_france #5' 'ftp5.fr.freebsd.org' 116 ' $msg_france #6' 'ftp6.fr.freebsd.org' 117 ' $msg_france #7' 'ftp7.fr.freebsd.org' 118 ' $msg_france #8' 'ftp8.fr.freebsd.org' 119 '$msg_germany' 'ftp.de.freebsd.org' 120 ' $msg_germany #2' 'ftp2.de.freebsd.org' 121 ' $msg_germany #4' 'ftp4.de.freebsd.org' 122 ' $msg_germany #5' 'ftp5.de.freebsd.org' 123 ' $msg_germany #6' 'ftp6.de.freebsd.org' 124 ' $msg_germany #7' 'ftp7.de.freebsd.org' 125 ' $msg_germany #8' 'ftp8.de.freebsd.org' 126 '$msg_greece' 'ftp.gr.freebsd.org' 127 ' $msg_greece #2' 'ftp2.gr.freebsd.org' 128 '$msg_ireland' 'ftp3.ie.freebsd.org' 129 '$msg_israel' 'ftp.il.freebsd.org' 130 '$msg_italy' 'ftp.it.freebsd.org' 131 '$msg_japan' 'ftp.jp.freebsd.org' 132 ' $msg_japan #2' 'ftp2.jp.freebsd.org' 133 ' $msg_japan #3' 'ftp3.jp.freebsd.org' 134 ' $msg_japan #4' 'ftp4.jp.freebsd.org' 135 ' $msg_japan #5' 'ftp5.jp.freebsd.org' 136 ' $msg_japan #6' 'ftp6.jp.freebsd.org' 137 ' $msg_japan #7' 'ftp7.jp.freebsd.org' 138 ' $msg_japan #8' 'ftp8.jp.freebsd.org' 139 ' $msg_japan #9' 'ftp9.jp.freebsd.org' 140 '$msg_korea' 'ftp.kr.freebsd.org' 141 ' $msg_korea #2' 'ftp2.kr.freebsd.org' 142 '$msg_latvia' 'ftp.lv.freebsd.org' 143 '$msg_lithuania' 'ftp.lt.freebsd.org' 144 '$msg_netherlands' 'ftp.nl.freebsd.org' 145 ' $msg_netherlands #2' 'ftp2.nl.freebsd.org' 146 '$msg_new_zealand' 'ftp.nz.freebsd.org' 147 '$msg_norway' 'ftp.no.freebsd.org' 148 '$msg_poland' 'ftp.pl.freebsd.org' 149 ' $msg_poland #2' 'ftp2.pl.freebsd.org' 150 '$msg_russia' 'ftp.ru.freebsd.org' 151 ' $msg_russia #2' 'ftp2.ru.freebsd.org' 152 ' $msg_russia #4' 'ftp4.ru.freebsd.org' 153 ' $msg_russia #5' 'ftp5.ru.freebsd.org' 154 ' $msg_russia #6' 'ftp6.ru.freebsd.org' 155 '$msg_slovak_republic' 'ftp.sk.freebsd.org' 156 ' $msg_slovak_republic #2' 'ftp2.sk.freebsd.org' 157 '$msg_slovenia' 'ftp.si.freebsd.org' 158 '$msg_south_africa' 'ftp.za.freebsd.org' 159 ' $msg_south_africa #2' 'ftp2.za.freebsd.org' 160 ' $msg_south_africa #4' 'ftp4.za.freebsd.org' 161 '$msg_spain' 'ftp.es.freebsd.org' 162 ' $msg_spain #3' 'ftp3.es.freebsd.org' 163 '$msg_sweden' 'ftp.se.freebsd.org' 164 ' $msg_sweden #2' 'ftp2.se.freebsd.org' 165 ' $msg_sweden #3' 'ftp3.se.freebsd.org' 166 ' $msg_sweden #4' 'ftp4.se.freebsd.org' 167 ' $msg_sweden #5' 'ftp5.se.freebsd.org' 168 ' $msg_sweden #6' 'ftp6.se.freebsd.org' 169 '$msg_switzerland' 'ftp.ch.freebsd.org' 170 '$msg_taiwan' 'ftp.tw.freebsd.org' 171 ' $msg_taiwan #2' 'ftp2.tw.freebsd.org' 172 ' $msg_taiwan #3' 'ftp3.tw.freebsd.org' 173 ' $msg_taiwan #4' 'ftp4.tw.freebsd.org' 174 ' $msg_taiwan #6' 'ftp6.tw.freebsd.org' 175 ' $msg_taiwan #11' 'ftp11.tw.freebsd.org' 176 '$msg_uk' 'ftp.uk.freebsd.org' 177 ' $msg_uk #2' 'ftp2.uk.freebsd.org' 178 ' $msg_uk #3' 'ftp3.uk.freebsd.org' 179 ' $msg_uk #4' 'ftp4.uk.freebsd.org' 180 ' $msg_uk #5' 'ftp5.uk.freebsd.org' 181 '$msg_ukraine' 'ftp.ua.freebsd.org' 182 ' $msg_ukraine #7' 'ftp7.ua.freebsd.org' 183 '$msg_usa #1' 'ftp1.us.freebsd.org' 184 ' $msg_usa #2' 'ftp2.us.freebsd.org' 185 ' $msg_usa #3' 'ftp3.us.freebsd.org' 186 ' $msg_usa #4' 'ftp4.us.freebsd.org' 187 ' $msg_usa #5' 'ftp5.us.freebsd.org' 188 ' $msg_usa #6' 'ftp6.us.freebsd.org' 189 ' $msg_usa #8' 'ftp8.us.freebsd.org' 190 ' $msg_usa #10' 'ftp10.us.freebsd.org' 191 ' $msg_usa #11' 'ftp11.us.freebsd.org' 192 ' $msg_usa #13' 'ftp13.us.freebsd.org' 193 ' $msg_usa #14' 'ftp14.us.freebsd.org' 194 ' $msg_usa #15' 'ftp15.us.freebsd.org' 195 " # END-QUOTE 196 local hline="$msg_select_a_site_thats_close" 197 198 local height width rows 199 eval f_dialog_menu_size height width rows \ 200 \"\$title\" \ 201 \"\$btitle\" \ 202 \"\$prompt\" \ 203 \"\$hline\" \ 204 $menu_list 205 206 local mtag 207 mtag=$( eval $DIALOG \ 208 --title \"\$title\" \ 209 --backtitle \"\$btitle\" \ 210 --hline \"\$hline\" \ 211 --ok-label \"\$msg_ok\" \ 212 --cancel-label \"\$msg_cancel\" \ 213 --menu \"\$prompt\" \ 214 $height $width $rows \ 215 $menu_list \ 216 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD 217 ) || return $FAILURE 218 f_dialog_data_sanitize mtag 219 220 case "$mtag" in 221 URL) setvar $VAR_FTP_PATH "other" ;; 222 *) 223 local value 224 value=$( eval f_dialog_menutag2item \"\$mtag\" $menu_list ) 225 setvar $VAR_FTP_PATH "ftp://$value" 226 esac 227 228 return $SUCCESS 229} 230 231# f_media_set_ftp 232# 233# Return success if we both found and set the media type to be an FTP server. 234# Variables from variable.subr that can be used to script user input: 235# 236# VAR_FTP_PATH 237# Can be a URL (including "ftp://" protocol-prefix) or "other" 238# (user is prompted to enter FTP URL). If a URL, can optionally 239# contain directory prefix after hostname/port. Valid examples 240# include: 241# ftp://myhost 242# ftp://somename:21/pub/ 243# ftp://192.168.2.3/pub/ 244# ftp://[::1]:21/ 245# The default port if not specified is 21. 246# VAR_NAMESERVER [Optional] 247# If set, overrides resolv.conf(5) and sets the nameserver that 248# is used to convert names into addresses (when a name converts 249# into multiple addresses, the first address to successfully 250# connect is used). 251# 252# Meanwhile, the following variables from variable.subr are set after 253# successful execution: 254# 255# VAR_FTP_HOST 256# The FTP host to connect to, parsed from VAR_FTP_PATH. In the 257# example case of IPv6 where VAR_FTP_PATH is "ftp://[::1]", this 258# variable will be set to "::1" (the outer brackets are removed). 259# VAR_FTP_PORT 260# The TCP port to connect to, parsed from VAR_FTP_PATH. Usually 261# 21 unless VAR_FTP_PATH was of one of the following forms: 262# ftp://hostname:OTHER_PORT 263# ftp://hostname:OTHER_PORT/* 264# ftp://ip:OTHER_PORT 265# ftp://ip:OTHER_PORT/* 266# ftp://[ip6]:OTHER_PORT 267# ftp://[ip6]:OTHER_PORT/* 268# VAR_FTP_DIR 269# If VAR_FTP_PATH contained a directory element (e.g., 270# "ftp://localhost/pub") this variable contains only the 271# directory element (e.g., "/pub"). 272# 273f_media_set_ftp() 274{ 275 f_media_close 276 277 local url 278 f_getvar $VAR_FTP_PATH url 279 280 # If we've been through here before ... 281 if f_struct device_network && [ "${url#$msg_other}" ]; then 282 f_dialog_yesno "$msg_reuse_old_ftp_site_selection_values" || 283 url= 284 fi 285 286 if [ ! "$url" ]; then 287 f_dialog_menu_media_ftp || return $FAILURE 288 f_getvar $VAR_FTP_PATH url 289 fi 290 [ "$url" ] || return $FAILURE 291 292 case "$url" in 293 other) 294 setvar $VAR_FTP_PATH "ftp://" 295 f_variable_get_value $VAR_FTP_PATH \ 296 "$msg_please_specify_url_of_a_freebsd_distribution" 297 f_getvar $VAR_FTP_PATH url 298 if [ ! "${url#ftp://}" ]; then 299 unset $VAR_FTP_PATH 300 return $FAILURE 301 fi 302 if [ ${#url} -gt ${URL_MAX:-261261} ]; then 303 f_show_msg "$msg_length_of_specified_url_is_too_long" \ 304 ${#url} ${URL_MAX:-261261} 305 unset $VAR_FTP_PATH 306 return $FAILURE 307 fi 308 case "$url" in 309 ftp://*) : valid URL ;; 310 *) 311 f_show_msg "$msg_sorry_invalid_url" "$url" 312 unset $VAR_FTP_PATH 313 return $FAILURE 314 esac 315 esac 316 case "$url" in 317 ftp://*) : valid URL ;; 318 *) 319 f_show_msg "$msg_sorry_invalid_url" "$url" 320 unset $VAR_FTP_PATH 321 return $FAILURE 322 esac 323 324 # Set the name of the FTP device to the URL 325 f_struct_new DEVICE device_ftp 326 device_ftp set name "$url" 327 328 if ! f_struct device_network || 329 ! f_dialog_yesno "$msg_youve_already_done_the_network_configuration" 330 then 331 f_struct device_network && 332 f_device_shutdown network 333 if ! f_device_select_tcp; then 334 unset $VAR_FTP_PATH 335 return $FAILURE 336 fi 337 local dev 338 f_getvar $VAR_NETWORK_DEVICE dev 339 f_struct_copy "device_$dev" device_network 340 fi 341 if ! f_device_init network; then 342 f_dprintf "f_media_set_ftp: %s" "$msg_net_device_init_failed" 343 unset $VAR_FTP_PATH 344 return $FAILURE 345 fi 346 347 local hostname="${url#*://}" port=21 dir=/ 348 case "$hostname" in 349 # 350 # The order in-which the below individual cases appear is important! 351 # 352 "["*"]":*/*) # IPv6 address with port and directory 353 f_dprintf "Looks like an IPv6 addr with port/dir: %s" \ 354 "$hostname" 355 hostname="${hostname#\[}" 356 port="${hostname#*\]:}" 357 port="${port%%[!0-9]*}" 358 dir="/${hostname#*/}" 359 hostname="${hostname%%\]:*}" 360 ;; 361 "["*"]":*) # IPv6 address with port 362 f_dprintf "Looks like an IPv6 addr with port: %s" "$hostname" 363 hostname="${hostname#\[}" 364 port="${hostname#*\]:}" 365 port="${port%%[!0-9]*}" 366 hostname="${hostname%%\]:*}" 367 ;; 368 "["*"]"/*) # IPv6 address with directory 369 f_dprintf "Looks like an IPv6 addr with dir: %s" "$hostname" 370 hostname="${hostname#\[}" 371 dir="/${hostname#*/}" 372 hostname="${hostname%%\]*}" 373 ;; 374 "["*"]") # IPv6 address 375 f_dprintf "Looks like an IPv6 addr: %s" "$hostname" 376 hostname="${hostname#\[}" 377 hostname="${hostname%\]}" 378 ;; 379 # 380 # ^^^ IPv6 above / DNS Name or IPv4 below vvv 381 # 382 *:*/*) # DNS name or IPv4 address with port and directory 383 f_dprintf "Looks like a %s with port/dir: %s" \ 384 "DNS name or IPv4 addr" "$hostname" 385 port="${hostname#*:}" 386 port="${port%%[!0-9]*}" 387 dir="/${hostname#*/}" 388 hostname="${hostname%%:*}" 389 ;; 390 *:*) # DNS name or IPv4 address with port 391 f_dprintf "Looks like a DNS name or IPv4 addr with port: %s" \ 392 "$hostname" 393 port="${hostname#*:}" 394 hostname="${hostname%%:*}" 395 ;; 396 */*) # DNS name or IPv4 address with directory 397 f_dprintf "Looks like a DNS name or IPv4 addr with dir: %s" \ 398 "$hostname" 399 dir="/${hostname#*/}" 400 hostname="${hostname%%/*}" 401 ;; 402 *) # DNS name or IPv4 address 403 f_dprintf "Looks like a DNS name or IPv4 addr: %s" "$hostname" 404 : leave hostname as-is 405 esac 406 407 f_dprintf "hostname = \`%s'" "$hostname" 408 f_dprintf "dir = \`%s'" "$dir" 409 f_dprintf "port \# = \`%d'" "$port" 410 411 local ns 412 f_getvar $VAR_NAMESERVER ns 413 [ "$ns" ] || f_resolv_conf_nameservers ns 414 if [ "$ns" -a ! "$FTP_SKIP_RESOLV" ] && ! { 415 f_validate_ipaddr "$hostname" || 416 f_validate_ipaddr6 "$hostname" 417 }; then 418 f_show_info "$msg_looking_up_host" "$hostname" 419 f_dprintf "%s: Looking up hostname, %s, using host(1)" \ 420 "f_media_set_ftp" "$hostname" 421 if ! f_quietly f_host_lookup "$hostname"; then 422 f_show_msg "$msg_cannot_resolve_hostname" "$hostname" 423 f_struct device_network && 424 f_device_shutdown network 425 f_struct_free device_network 426 unset $VAR_FTP_PATH 427 return $FAILURE 428 fi 429 f_dprintf "Found DNS entry for %s successfully." "$hostname" 430 fi 431 432 setvar $VAR_FTP_HOST "$hostname" 433 setvar $VAR_FTP_PORT "$port" 434 setvar $VAR_FTP_DIR "$dir" 435 436 device_ftp set type $DEVICE_TYPE_FTP 437 device_ftp set init f_media_init_ftp 438 device_ftp set get f_media_get_ftp 439 device_ftp set shutdown f_media_shutdown_ftp 440 device_ftp set private network 441 f_struct_copy device_ftp device_media 442 f_struct_free device_ftp 443 444 return $SUCCESS 445} 446 447# f_media_set_ftp_active 448# 449# Wrapper to f_media_set_ftp to access FTP servers actively. 450# 451f_media_set_ftp_active() 452{ 453 setvar $VAR_FTP_STATE "active" 454 f_media_set_ftp 455} 456 457# f_media_set_ftp_passive 458# 459# Wrapper to f_media_set_ftp to access FTP servers passively. 460# 461f_media_set_ftp_passive() 462{ 463 setvar $VAR_FTP_STATE "passive" 464 f_media_set_ftp 465} 466 467# f_media_set_ftp_userpass 468# 469# Prompt the user to enter/confirm the username/password variables that will 470# be used to communicate with the FTP servers. Returns success if the user does 471# not cancel or press Esc to either username or password. 472# 473# Variables from variable.subr that can be used to script user input: 474# 475# VAR_FTP_USER 476# The username to send via ftp(1) when connecting to an FTP 477# server. 478# VAR_FTP_PASS 479# The password to send with the above username. 480# 481# Does not prompt for confirmation of values if VAR_NONINTERACTIVE is set (see 482# variable.subr for more information). 483# 484f_media_set_ftp_userpass() 485{ 486 local user pass 487 f_variable_get_value $VAR_FTP_USER \ 488 "$msg_please_enter_the_username_you_wish_to_login_as" 489 f_getvar $VAR_FTP_USER user 490 if [ "$user" ]; then 491 f_variable_get_value $VAR_FTP_PASS \ 492 "$msg_please_enter_the_password_for_this_user" 493 f_getvar $VAR_FTP_PASS pass 494 else 495 pass= 496 fi 497 [ "$pass" ] # Return status 498} 499 500# f_device_network_up $device 501# 502# Brings up attached network device, if any - takes FTP device as arg. 503# 504f_device_network_up() 505{ 506 local dev="$1" netDev 507 f_struct device_$dev || return $FAILURE 508 device_$dev get private netDev || return $SUCCESS # No net == happy net 509 f_device_init $netDev 510} 511 512# f_device_network_down $device 513# 514# Brings down attached network device, if any - takes FTP device as arg. 515# 516f_device_network_down() 517{ 518 local dev="$1" netDev 519 f_struct device_$dev || return $FAILURE 520 device_$dev get private netDev || return $SUCCESS 521 f_device_shutdown $netDev 522} 523 524# f_media_init_ftp $device 525# 526# Initializes the FTP media device. Returns success if both able to log into 527# the FTP server and confirm the existence of at least one known release path 528# using ftp(1). 529# 530# Variables from variable.subr used to initialize the connection are as follows 531# (all of which are configured by f_media_set_ftp above): 532# 533# VAR_FTP_PATH 534# The unparsed FTP URL representing the server to contact. 535# Usually "ftp://server" for example. Can contain TCP port number 536# and/or directory path (but should not contain username/password 537# info). 538# VAR_FTP_HOST 539# The FTP host to connect to. Can be an IPv4 address (e.g., 540# 127.0.0.1), IPv6 address (e.g., ::1), or DNS hostname. Usually 541# set automatically in f_media_set_ftp() by parsing VAR_FTP_PATH. 542# VAR_FTP_PORT 543# The TCP port to connect to. Usually set automatically in 544# f_media_set_ftp() by parsing VAR_FTP_PATH. 545# VAR_FTP_DIR 546# The base FTP directory to use when downloading files from the 547# FTP server. Usually set automatically in f_media_set_ftp() by 548# parsing VAR_FTP_PATH. 549# VAR_FTP_USER [Optional] 550# If unset, defaults to using anonymous access. 551# VAR_FTP_PASS [Optional] 552# If unset, defaults to a sensible value. 553# 554# In addition, the following (managed either manually or by f_media_set_ftp_*): 555# 556# VAR_FTP_STATE 557# Sets FTPMODE for ftp(1) and can be one of: 558# active active mode FTP only 559# auto automatic determination of passive or active 560# (this is the default) 561# gate gate-ftp mode 562# passive passive mode FTP only 563# See ftp(1) for additional information. 564# 565# And last, but not least (managed automatically or manually): 566# 567# VAR_RELNAME 568# Defaults to being set to $(uname -r) but can be overridden. 569# This sets the name of a release to look for as part of a well 570# known set of paths to search for release data once connected 571# via FTP. If set to "__RELEASE" or "any" then the VAR_FTP_DIR is 572# taken as the absolute path to the release and no further 573# searching is done (see FTP_DIRS above in the GLOBALS section 574# for a list of well known paths that are used when searching for 575# a VAR_RELNAME sub-directory). 576# 577f_media_init_ftp() 578{ 579 local dev="$1" 580 581 local url 582 device_$dev get name url 583 f_dprintf "Init routine called for FTP device. url=[%s]" "$url" 584 585 if [ "$FTP_INITIALIZED" ]; then 586 f_dprintf "FTP device already initialized." 587 return $SUCCESS 588 fi 589 590 # If we can't initialize the network, bag it! 591 f_device_network_up $dev || return $FAILURE 592 593 local cp 594 while :; do 595 f_getvar $VAR_FTP_PATH cp 596 if [ ! "$cp" ]; then 597 if ! f_media_set_ftp || 598 ! f_getvar $VAR_FTP_PATH cp || 599 [ ! "$cp" ] 600 then 601 f_show_msg "$msg_unable_to_get_proper_ftp_path" 602 f_device_network_down $dev 603 return $FAILURE 604 fi 605 fi 606 607 local ftp_host ftp_dir 608 if ! { 609 f_getvar $VAR_FTP_HOST ftp_host && 610 f_getvar $VAR_FTP_DIR ftp_dir 611 }; then 612 f_show_msg "$msg_missing_ftp_host_or_directory" 613 f_device_network_down $dev 614 return $FAILURE 615 fi 616 617 local ftp_port 618 f_getvar $VAR_FTP_PORT ftp_port 619 local host="$ftp_host" port="${ftp_port:+:$ftp_port}" 620 case "$host" in *:*) host="[$host]"; esac 621 622 local user pass use_anon= 623 f_getvar $VAR_FTP_USER user 624 if [ ! "$user" ]; then 625 user="anonymous" 626 use_anon=1 627 fi 628 if ! f_getvar $VAR_FTP_PASS pass; then 629 f_getvar $VAR_HOSTNAME cp 630 if f_running_as_init; then 631 pass="installer@$cp" 632 else 633 local name="$( id -un 2> /dev/null )" 634 pass="${name:-ftp}@$cp" 635 fi 636 fi 637 638 f_show_info "$msg_logging_in_to_user_at_host" \ 639 "$user" "$ftp_host" 640 641 local userpass="" 642 if [ ! "$use_anon" ] && [ "$user" -o "$pass" ]; then 643 userpass="$user${pass:+:$( f_uriencode "$pass" )}" 644 userpass="$userpass${userpass:+@}" 645 fi 646 647 local mode rx 648 f_getvar $VAR_FTP_STATE mode 649 650 if [ "$ftp_dir" ]; then 651 if ! rx=$( 652 printf 'cd "%s"\npwd\n' "$ftp_dir" | eval \ 653 FTPMODE=\"\$mode\" \ 654 ${use_anon:+FTPANONPASS=\"\$pass\"} \ 655 ftp -V ${use_anon:+-a} \ 656 \"ftp://\$userpass\$host\$port\" \ 657 2>&1 658 ); then 659 f_show_msg "$msg_couldnt_open_ftp_connection" \ 660 "$ftp_host" "$rx" 661 break # to failure 662 fi 663 if echo "$rx" | awk -v dir="/${ftp_dir#/}" ' 664 BEGIN { 665 found = 0 666 if ( dir != "/" ) sub("/$", "", dir) 667 } 668 /^Remote directory: / { 669 sub(/^[^:]*:[[:space:]]*/, "") 670 if ($0 != dir) next 671 found = 1; exit 672 } 673 END { exit ! found } 674 '; then 675 setvar $VAR_FTP_DIR "$ftp_dir" 676 setvar $VAR_FTP_PATH \ 677 "ftp://$ftp_host/${ftp_dir#/}" 678 else 679 f_show_msg \ 680 "$msg_please_check_the_url_and_try_again" \ 681 "ftp://$ftp_host/${ftp_dir#/}" 682 break # to failure 683 fi 684 fi 685 686 # 687 # Now that we've verified that the path we're given is ok, 688 # let's try to be a bit intelligent in locating the release we 689 # are looking for. First off, if the release is specified as 690 # "__RELEASE" or "any", then just assume that the current 691 # directory is the one we want and give up. 692 # 693 local rel 694 f_getvar $VAR_RELNAME rel 695 f_dprintf "f_media_init_ftp: rel=[%s]" "$rel" 696 697 case "$rel" in 698 __RELEASE|any) 699 FTP_INITIALIZED=YES 700 return $SUCCESS 701 ;; 702 *) 703 # 704 # Ok, since we have a release variable, let's walk 705 # through the list of directories looking for a release 706 # directory. First successful CWD wins. 707 # 708 if ! rx=$( 709 for dir in $FTP_DIRS; do 710 # Avoid confusing some servers 711 [ "$dir" = "." ] && continue 712 printf 'cd "/%s/%s"\npwd\n' \ 713 "$dir" "$rel" 714 done | eval \ 715 FTPMODE=\"\$mode\" \ 716 ${use_anon:+FTPANONPASS=\"\$pass\"} \ 717 ftp -V ${use_anon:+-a} \ 718 \"ftp://\$userpass\$host\$port\" \ 719 2>&1 720 ); then 721 f_show_msg "$msg_couldnt_open_ftp_connection" \ 722 "$ftp_host" "$rx" 723 break # to failure 724 fi 725 726 local fdir 727 if fdir=$( echo "$rx" | awk ' 728 BEGIN { found = 0 } 729 /^Remote directory: / { 730 sub(/^[^:]*:[[:space:]]*/, "") 731 if ($0 == "/") next 732 # Exit after the first dir 733 found++; print; exit 734 } 735 END { exit ! found } 736 ' ); then 737 setvar $VAR_FTP_DIR "$fdir" 738 setvar $VAR_FTP_PATH "ftp://$ftp_host$fdir" 739 FTP_INITIALIZED=YES 740 return $SUCCESS 741 else 742 f_yesno "$msg_cant_find_distribution" \ 743 "$rel" "$ftp_host" 744 if [ $? -eq $SUCCESS ]; then 745 unset $VAR_FTP_PATH 746 f_media_set_ftp && continue 747 fi 748 fi 749 esac 750 break # to failure 751 done 752 753 unset FTP_INITIALIZED $VAR_FTP_PATH 754 f_device_network_down $dev 755 return $FAILURE 756} 757 758# f_media_get_ftp $device $file [$probe_type] 759# 760# Returns data from $file on an FTP server using ftp(1). Please note that 761# $device is unused but must be present (even if null). Information is instead 762# gathered from the environment. If $probe_type is present and non-NULL, 763# returns success if $file exists. If $probe_type is equal to $PROBE_SIZE, 764# prints the size of $file in bytes to standard-out. 765# 766# Variables from variable.subr used to configure the connection are as follows 767# (all of which are configured by f_media_set_ftp above): 768# 769# VAR_FTP_HOST 770# FTP host to connect to. Can be an IPv4 address, IPv6 address, 771# or DNS hostname of your choice. 772# VAR_FTP_PORT 773# TCP port to connect on; see f_media_set_ftp() above. 774# VAR_FTP_USER [Optional] 775# If unset, defaults to using anonymous access. 776# VAR_FTP_PASS [Optional] 777# If unset, defaults to a sensible value. 778# 779# In addition, the following (managed either manually or by f_media_set_ftp_*): 780# 781# VAR_FTP_STATE 782# Sets FTPMODE for ftp(1) and can be one of: 783# active active mode FTP only 784# auto automatic determination of passive or active 785# (this is the default) 786# gate gate-ftp mode 787# passive passive mode FTP only 788# See ftp(1) for additional information. 789# 790# See variable.subr for additional information. 791# 792# Example usage: 793# f_media_set_ftp 794# f_media_get_ftp media $file 795# 796f_media_get_ftp() 797{ 798 local dev="$1" file="$2" probe_type="$3" hosts= 799 800 f_dprintf "f_media_get_ftp: dev=[%s] file=[%s] probe_type=%s" \ 801 "$dev" "$file" "$probe_type" 802 803 local ftp_host ftp_port 804 f_getvar $VAR_FTP_HOST ftp_host 805 f_getvar $VAR_FTP_PORT ftp_port 806 807 if [ ! "$FTP_INITIALIZED" ]; then 808 f_dprintf "No FTP connection open, can't get file %s" "$file" 809 return $FAILURE 810 fi 811 812 if ! { 813 f_validate_ipaddr "$ftp_host" || 814 f_validate_ipaddr6 "$ftp_host" || 815 { 816 f_dprintf "%s: Looking up hostname, %s, using host(1)" \ 817 "f_media_get_ftp" "$ftp_host" 818 f_host_lookup "$ftp_host" hosts 819 } 820 }; then 821 # All the above validations failed 822 [ "$hosts" ] && f_dialog_msgbox "$hosts" 823 return $FAILURE 824 elif [ ! "$hosts" ]; then 825 # One of the first two validations passed 826 hosts="$ftp_host" 827 fi 828 829 local host connected= 830 for host in $hosts; do 831 f_quietly nc -nz "$host" "$ftp_port" || continue 832 connected=1; break 833 done 834 if [ ! "$connected" ]; then 835 f_show_msg "$msg_couldnt_connect_to_ftp_server %s:%s" \ 836 "$ftp_host" "$ftp_port" 837 return $FAILURE 838 fi 839 840 local user pass use_anon= 841 f_getvar $VAR_FTP_USER user 842 if [ ! "$user" ]; then 843 user="anonymous" 844 use_anon=1 845 fi 846 if ! f_getvar $VAR_FTP_PASS pass; then 847 f_getvar $VAR_HOSTNAME cp 848 if f_running_as_init; then 849 pass="installer@$cp" 850 else 851 local name="$( id -un 2> /dev/null )" 852 pass="${name:-ftp}@$cp" 853 fi 854 fi 855 856 local userpass="" 857 if [ ! "$use_anon" ] && [ "$user" -o "$pass" ]; then 858 userpass="$user${pass:+:$( f_uriencode "$pass" )}" 859 userpass="$userpass${userpass:+@}" 860 fi 861 862 local dir mode rx 863 f_getvar $VAR_FTP_DIR\#/ dir 864 f_getvar $VAR_FTP_STATE mode 865 866 local port="${ftp_port:+:$ftp_port}" 867 case "$host" in *:*) host="[$host]"; esac 868 869 f_dprintf "sending ftp request for: %s" "ftp://$host$port/$dir/$file" 870 871 if [ "$probe_type" ]; then 872 local url="ftp://$userpass$host$port/$dir/$file" size 873 [ "$use_anon" ] && url="ftp://$host$port/$dir/$file" 874 if ! size=$( fetch -s "$url" 2>&1 ) || ! f_isinteger "$size" 875 then 876 f_dprintf "request failed! size response=[%s]" "$size" 877 [ "$probe_type" = "$PROBE_SIZE" ] && echo "-1" 878 return $FAILURE 879 fi 880 [ "$probe_type" = "$PROBE_SIZE" ] && echo "$size" 881 return $SUCCESS 882 fi 883 884 eval FTPMODE=\"\$mode\" ${use_anon:+FTPANONPASS=\"\$pass\"} \ 885 ftp -V ${use_anon:+-a} -o - \ 886 \"ftp://\$userpass\$host\$port/\$dir/\$file\" 2> /dev/null 887 local retval=$? 888 889 [ $retval -eq $SUCCESS ] || f_dprintf "request failed!" 890 return $retval 891} 892 893# f_media_shutdown_ftp $device 894# 895# Shuts down the FTP device. Return status should be ignored. Note that since 896# we don't maintain an open connection to the FTP server there's nothing to do. 897# 898f_media_shutdown_ftp() 899{ 900 [ "$FTP_INITIALIZED" ] || return $SUCCESS 901 902 unset FTP_INITIALIZED 903} 904 905############################################################ MAIN 906 907f_dprintf "%s: Successfully loaded." media/ftp.subr 908 909fi # ! $_MEDIA_FTP_SUBR 910