Merge lp:~utlemming/cloud-init/cloud-init.profile.d into lp:~cloud-init-dev/cloud-init/trunk

[Ben Howard]

Added profile.d script to inform users of bad locales.

[Scott Moser (smoser)]

A couple things:
a.) use 'locale 2>&1 | locale_warn' as opposed to the here document.
   I was surprised at what was so slow in this, and its the here document. Use a pipe and its much faster.
   since we're not modifiying the environment at all, that is ok.

b.) I don't know how i feel about the /var/lib/cloud/instance/ setting... i think i'd at least like the option of something to be multi-instance, and also would like a per-user setting. as the user who logs in cannot necessarily modify /var/lib/cloud/instance/ . So just loop over a list of files, that can include the /var/lib/cloud/instance path

c.) apt-cache search "^language-pack-[a-z][a-z]$"
   might be slightly better, as the filtering is then built in.

[Scott Moser (smoser)]

oh, and you can't return outside a function:
  [ -f /var/lib/cloud/instance/locale.skip ] && return

At http://bazaar.launchpad.net/~smoser/cloud-init/precise-locale-warning/revision/169 , i had:
 [ -f /etc/default/cloud-locales -o -f ~/.cloud-locales ] ||
    locale 2>&1 | cloud_locale_warn

[Scott Moser (smoser)]

review: Needs Fixing

[lp:~utlemming/cloud-init/cloud-init.profile.d]

554. By Ben Howard on 2012-04-02

Fixed deficiency in merge proposal.

Unmerged revisions

=== added directory 'profile.d'
=== added file 'profile.d/Z99-cloud-locale-test.sh'
--- profile.d/Z99-cloud-locale-test.sh	1970-01-01 00:00:00 +0000
+++ profile.d/Z99-cloud-locale-test.sh	2012-04-02 23:06:19 +0000
@@ -0,0 +1,82 @@
+#!/bin/sh
+# vi: ts=4 noexpandtab
+#
+# Author: Ben Howard <[e-mail]>
+# Author: Scott Moser <[e-mail]>
+# (c) 2012, Canonical Group, Ltd.
+#
+# Purpose: Detect invalid locale settings and inform the user
+#  of how to fix them.
+#
+
+locale_warn() {
+	local cr="
+"
+	local line bad_names="" bad_lcs="" key="" value="" var=""
+	local w1 w2 w3 w4 remain
+	# locale is expected to output either:
+	# VARIABLE=
+	# VARIABLE="value"
+	# locale: Cannot set LC_SOMETHING to default locale
+	while read -r w1 w2 w3 w4 remain; do
+		case "$w1" in
+			locale:) bad_names="${bad_names} ${w4}";;
+			*)
+				key=${w1%%=*}
+				val=${w1#*=}
+				val=${val#\"}
+				val=${val%\"}
+				vars="${vars} $key=$val";;
+		esac
+	done
+	for bad in $bad_names; do
+		for var in ${vars}; do
+			[ "${bad}" = "${var%=*}" ] &&
+				bad_lcs="${bad_lcs} ${var#*=}" && break 2
+		done
+	done
+	bad_lcs=${bad_lcs# }
+	[ -n "$bad_lcs" ] || return 0
+
+	printf "_____________________________________________________________________\n"
+	printf "WARNING! Your environment specifies an invalid locale.\n"
+	printf " This can affect your user experience significantly, including the\n"
+	printf " ability to manage packages. You may install the locales by running\n"
+	printf " the following command(s):\n\n"
+
+	local bad invalid="" to_gen="" sfile="/usr/share/i18n/SUPPORTED"
+	if [ ! -e "$sfile" ]; then
+		printf "  sudo apt-get install locales\n"
+	fi
+	if [ -e "$sfile" ]; then
+		for bad in ${bad_lcs}; do
+			grep -q -i "${bad}" "$sfile" &&
+				to_gen="${to_gen} ${bad}" ||
+				invalid="${invalid} ${bad}"
+		done
+	else
+		to_gen=$bad_lcs
+	fi
+
+	for bad in ${to_gen}; do
+		printf "   sudo apt-get install language-pack-${bad%%_*}\n"
+		printf "   sudo locale-gen ${bad}\n"
+	done
+	printf "\n"
+	for bad in ${invalid}; do
+        	printf "WARNING: '${bad}' is an invalid locale\n"
+	done
+
+	printf "To see all available language packs, run:\n"
+	printf "   apt-cache search \"^language-pack-[a-z][a-z]$\"\n"
+	printf "To disable for all users, run:\n"
+	printf "   sudo touch /var/lib/cloud/instance/locale-check.skip\n"
+	printf "To disable this check for this user only, run: \n"
+	printf "   touch ~/.locale-test.skip \n"
+	printf "_____________________________________________________________________\n\n"
+}
+
+[ -f /home/${USER}/.locale-test.skip -o -f /var/lib/cloud/instance/locale-check.skip ] ||
+	locale 2>&1 | locale_warn
+
+unset locale_warn

=== modified file 'setup.py'
--- setup.py	2011-12-20 16:39:46 +0000
+++ setup.py	2012-04-02 23:06:19 +0000
@@ -47,5 +47,6 @@
                   ('/usr/share/doc/cloud-init', filter(is_f,glob('doc/*'))),
                   ('/usr/share/doc/cloud-init/examples', filter(is_f,glob('doc/examples/*'))),
                   ('/usr/share/doc/cloud-init/examples/seed', filter(is_f,glob('doc/examples/seed/*'))),
+                  ('/etc/profile.d', filter(is_f,glob('profile.d/*')))
                   ],
       )