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