bsdinstall: Fix wifi network selection size

Use correct variable while creating dialog used to select among
available wireless networks

Approved by: asiciliano
Sponsored by: Rubicon Communications, LLC ("Netgate")
Differential Revision: https://reviews.freebsd.org/D45271

Remove $FreeBSD$: one-line sh pattern

Remove /^\s*#[#!]?\s*\$FreeBSD\$.*$\n/

bsdinstall: allow whitelabeling the scripts

Approved by: allanjude, asiciliano
Differential Revision: https://reviews.freebsd.org/D35197
Sponsored by: Rubicon Communications, LLC ("Netgate")

wlanconfig: allow to enter WiFi details if no networks found

Improve the installer: wlanconfig allows user to enter WiFi details
if no networks found, useful to connect to a hidden SSID.

PR: 246192
Reported by: emaste
Approved by: bapt (mentor)
Differential Revision: https://reviews.freebsd.org/D34149

Fix indentation in bsdinstall-created wpa_supplicant.conf

PR: base/221982
Reported by: emaste
Reviewed by: emaste, allanjude
MFC after: 0 days
X-MFC-to: stable/11
Differential Revision: https://reviews.freebsd.org/D23641

Fix indentation in bsdinstall-created wpa_supplicant.conf

r309934 cleaned up some cases in bsdinstall to use heredocs but broke
the indentation of the generated output, because <<- heredocs strip
leading tabs.

PR: 221982
Reviewed by: allanjude, dteske
MFC after: 2 weeks
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D13190

Revert r309918 -- modern POSIX has deprecated -<#>/+<#> syntax

Special thanks to: jilles

It's completely pointless to replace newlines with space
(this is done automatically for you upon shell expansion)

The flags of a WLAN need to be quoted (they contain things like brackets)

Simplify single-line if statements

Simplify loop by moving predicate to clause

Wordsmithing

Why test $? when you can test the command

Restore previous comment

Both simplify bringup of interface after changes and catch errors in debug

Calculate proper size of menu list dialog

There's an API function for catching errors and displaying them or
logging them to debug output

There's an API function for displaying pauses

There's an API function for displaying yes/no dialogs

There's an API function for displaying errors

Comment

Whitespace alignment

Relying on dialog auto-sizing (width/height/rows = 0) is a mistake
Use the provided API for calculating the appropriate size of menus

Remove unnecessary quotes

Add missing quotes

In awk, if you're going to append a newline to your printf
AND you're going to print only the argument, just use print

This statement has too many backslashes

Neither printf (and as is commonly known) nor print need parens in awk

Whitespace and alignment

You don't need parentheses for awk's printf

Continued resolution of conveluted statement
We shouldn't be coding things like "x || (x && x) || x || x || x ..."

These two error messages have always been backwards since inception

Why use $? when you can use the command itself

If the first ping succeeded, why on Earth should we ping it again?

Start deconstructing a conveluted hunk of code

Remove completely unnecesary parentheses

Why repeat yourself when you can send stderr to the same place as stdout?

Properly quote variable

Use more generic f_yesno() from provided API

The output of dialog needs to be sanitized
for portability/compatibility requirements

Whitespace alignment

Sort the domains

The --no-items and --stdout options are non-standard and should be avoided

From the dialog(1) manual:
using [--stdout] in portable scripts is not recommended

More efficiently make use of the exit status

Stop repeating strings (centralize prompt string)
NB: Changes to strings now only affect a single line

Add missing backslash (no real effect; it's pedantic and correct for
the interpolation level)

Use the oft-neglected awk syntax "startcondition, stopcondition { ... }" to
process the range of country labels which appear as columnar list from the
"ifconfig DEV list countries" command. Not only improving maintainability,
but also properly encapsulating arguments in single-quotes instead of
trying to escape whitespace. It is also completely unnecessary to collapse
newlines into whitespace (shell will do this for you automatically upon
expansion of the contents where necessary).

NB: This also changes the sorting algorithm to sort on the country code,
not the country name. The type-ahead feature of dialog is destroyed if the
tags are not sorted properly.

Quote WLAN_IFACE (pedantic)

In awk, casting a variable as a boolean condition is the same as testing if
the length of the variable contents is greater than zero

This allows us to also move the secondary condition into the action clause

Remove an unnecessary call to f_dialog_title_restore()

Whitespace

Utilize provided i18n strings

Remove incomplete and unnecessary creation of fd3

The provided API already provides a passthru descriptor and even
gives you a varaible for referring to it.

Remove unnecessary semi-colons

Use awk the following (more succinct) awk syntax:

condition1 { action1 }
condition2 { action2 }

instead of the following syntax:

{
if (condition1) { action1 }
else if (condition2) { action2 }
}

1 is the default descriptor for redirects without an fd prefix

Fix invalid parameter expansion (change $@ to "$@")

Without quotes, $@ loses its special meanining (see below)

% sh -c 'echo $@' /bin/sh " 1 " " 2 "
1 2
% sh -c 'echo "$@"' /bin/sh " 1 " " 2 "
1 2

The quotes are required to get ARGV to be unperterped

Allow the script path to contain whitespace and special characters

Use provided API to centralize dialog title strings

Reorder dialog parameters based on commonality for readability

Fix incorrect use of provided API
The result of which was incorrectly sized menu dialogs

Use provided API (change "dialog" to "$DIALOG")

Whitespace (dialog options separated to minimize diffs)

Consolidate redirects into here documents, with proper code indentation

Remove an unnecessary "return $?" at end of function

Use ternary operator

If you're not going to make use of the products of a match() in awk
(e.g., RSTART and RLENGTH variables) then use ~ instead of match()

Now that these variables do not contain the --default-item flag itself,
change the name of the variable from $def_item_... to $default_...

Always pass --default-item parameter to dialog

There is zero harm in always passing --default-item to dialog

Centralize backtitle string

Use provided API instead of hard-coded status integers

Whitespace

Remove unnecessary `-n' parameter to head/tail

awk(1) match() takes a regex, use /.../ to remind ourselves of this
NB: The difference between "..." and /.../ for a regex in awk is that
quoted strings go through escape expansion first (e.g., \\ becomes \)

Be internally consistent (": > ..." is used elsewhere in this file)

"echo | sed | sed | awk" is silly (changed to "echo | awk")

Add missing `-e' parameter to sed invocations

Allow $BSDINSTALL_TMPETC to contain whitespace or special chars

Group fallbacks together

Remove unnecessary quotes around number in test

Change "[ ! ... ] && ..." to "[ ... ] || ..."

Collapse tiny if statements

Replace funny block with something easy to digest

Consolidate locals

Remove unnecessary local initializers

Change "[ ! -z ... ]" => "[ ... ]" and "[ -z ... ]" => "[ ! ... ]"

Use $( ... ) instead of `...`

Comments

Functions in their own section

Remove unnecessary trailing backslashes

Add support for "hidden" Wi-Fi networks

PR: bin/214933
Submitted by: Maxim Filimonov <che@bein.link>
Reviewed by: dteske, allanjude, adrian
MFC after: 6 days
X-MFC-with: Follow-up commit for style

bsdinstall: add country/regulatory domain configuration dialog.

Allow to setup country and/or regulatory domain before scanning
(since channel list is affected by regulatory restrictions this may
impact scan results).

PR: 182600 (originally)
Differential Revision: https://reviews.freebsd.org/D6325

Use a variable for readability

MFC after: 3 days
X-MFC-to: stable/10

Allow bsdinstall to use WPA-Enterprise networks when installing. This
only allows basic username/password config, and does not provide the
ability to set any of the other WPA options. Regardless, this is
generally sufficient to associate.

Perhaps in the future this could allow full configuring (e.g. being able
to set "anonymous identity", and perhaps some of the more obscure WPA
options), though perhaps that will better belong in bsdconfig when that
grows wlan config ability.

MFC after: 1 week

Lower the priority of the "connect to any open wireless network" network
description, so guaranteeing that any other defined network will be tried
first.

MFC after: 1 week

Remove what appears to be a stray debugging printf.

MFC after: 1 week

A series of changes tested together as a whole:
+ Add a `-D FILE" command-line option for overriding the path to the
bsdinstall log file (BSDINSTALL_LOG env var).
+ Document new `-D FILE' in the man page for bsdinstall.
+ If FILE in `-D FILE' begins with a +, debug output goes to stdout
(interleaved between dialog(1) invocations/output) as well as to FILE
(minus the leading + of course).
+ If BSDINSTALL_LOG cannot be written, then debugging is disabled (except in
the case of a leading + in the pathname, wherein debug will still be
printed to stdout).
+ Update source code formatting style.
+ Fix a dangling participle ("Begun ..." -> "Began ...")
+ Rewrite the docsinstall script (was necessary to abate direct dependency
on BSDINSTALL_LOG (instead, use fault-tolerant bsdconfig framework which
displays appropriate errors for package management).
NB: docsinstall is still using pkg(8) after this change.
+ Add additional debug output for dhclient/rtsol/wpa_cliscan
+ Display script errors in a textbox rather than just on stdout
+ Update many coments.
+ Add new f_show_err() API call (like f_show_msg but changes the dialog
title to "Error")(see bsdconfig's `common.subr').
+ Add new f_eval_catch() API call for executing a command via eval but not
before logging the command to debug. Several example cases documented in
API header for function in bsdconfig's `common.subr'.
+ Fix dialog auto-sizing when launched as an rvalue to a pipe for indirected
scripts (previously would default to 24x80 sizing in this case, now it can
autosize to full size even when in a pipe chain).
+ Fix bug in f_snprintf if $format argument began with "-"; printf would
misinterpret as a flag. (this is in bsdcofig's `strings.subr').
+ Add accompanying f_sprintf() and f_vsprintf() to go along with already
existing f_snprintf() and f_vsnprintf() (see bsdconfig's `strings.subr').
+ Remove some unnecessary default ZFS datasets from the automatic "zfsboot"
script. Such as: /usr/ports/distfiles /usr/ports/packages /usr/obj /var/db
/var/empty /var/mail and /var/run (these can all be created as-needed once
the system is installed).
+ Remove setuid=off for /usr/home (as discussed from last round of CFT).
+ Fix some i18n string violations in "zfsboot".
+ Bolster debugging output in "zfsboot".
+ Fix some string quoting issues in "zfsboot".
+ Fix some variable scope issues in "zfsboot".
+ Change "Create" to "Install" in "zfsboot" main menu.
+ Increase error checking in "zfsboot" (type-check arguments and such).
+ Add call to "graid destroy" killing automatic metadata (part of the series
of pedantic destructions we do when bootstrapping a new/naked disk).
+ Make judicious use of new f_eval_catch() in "zfsboot".
+ Fixup some variable names for consistency (zfsboot).
+ Fix an underride syntax parameter expansion folly (zfsboot).
+ Confirm layout if not explicitly chosen when blindly proceeding (no
longer have to touch anything on the ZFS menu if it scares you, just
choose the omnibus "Install" option at the top and you'll be prompted to
select vdev type and disks in the layout confirmation dialog).
+ Change numbered menu items to alphabetic for more efficient navigation.
+ Consolidate vdev selection and disk selection into a single stateful
menu which performs validation and allows backing out to each previous
menu as you go deeper.
+ Redesign the ``Last Chance'' dialog (still using the same colors, but
make it conform to a tolerable width and make disks appear in a block-
quote style indented region).
+ Fix a bug wherein we used the a lowercase variable name by accident
(actual variable name declared as all-uppercase) at the time of
initializing fstab(5) (not believed to cause any issues though).
+ Update the geli setup infobox for each provider being initialized
(not just at the onset -- since each ``geli init'' causes kernel messages
to push our infobox off-screen).

Reviewed by: Allan Jude <freebsd@allanjude.com>
Discussed on: -current
MFC after: 3 days

Properly quote argument.

MFC after: 3 days

Allow WPA PSKs up to 63 characters, the max length according to
wpa_supplicant.conf(5). Up to now, the PSK was truncated
to 15 characters (the length of the input field).

PR: 159559
Submitted by: Gavin Chappell <gavin.chappell@gmail.com>
Approved by: re (kib)

Check correctly for whether there are any available wireless networks. This
was tested on a train in the middle of an upstate New York swamp.

Import bsdinstall. This is meant to be (eventually in conjunction with
pc-sysinstall) a replacement for sysinstall in the 9.0 release and beyond.
Currently supported platforms are sparc64, pc98, i386, amd64, powerpc, and
powerpc64. Integration into the build system will occur in the coming
weeks.

Merging with pc-sysinstall will use this code as a frontend, while
temporarily retaining the interactive partition editor here. This work
will be done in parallel with improvements on this code and release
integration.

Thanks to all who have provided testing and comments!