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