xref: /freebsd/usr.sbin/bsdconfig/share/packages/index.subr (revision 9ecd54f24fe9fa373e07c9fd7c052deb2188f545)
187c16275SDevin Teskeif [ ! "$_PACKAGES_INDEX_SUBR" ]; then _PACKAGES_INDEX_SUBR=1
287c16275SDevin Teske#
387c16275SDevin Teske# Copyright (c) 2013 Devin Teske
4f8ea072aSDevin Teske# All rights reserved.
587c16275SDevin Teske#
687c16275SDevin Teske# Redistribution and use in source and binary forms, with or without
787c16275SDevin Teske# modification, are permitted provided that the following conditions
887c16275SDevin Teske# are met:
987c16275SDevin Teske# 1. Redistributions of source code must retain the above copyright
1087c16275SDevin Teske#    notice, this list of conditions and the following disclaimer.
1187c16275SDevin Teske# 2. Redistributions in binary form must reproduce the above copyright
1287c16275SDevin Teske#    notice, this list of conditions and the following disclaimer in the
1387c16275SDevin Teske#    documentation and/or other materials provided with the distribution.
1487c16275SDevin Teske#
1587c16275SDevin Teske# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
168e37a7c8SDevin Teske# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1787c16275SDevin Teske# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1887c16275SDevin Teske# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1987c16275SDevin Teske# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
208e37a7c8SDevin Teske# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2187c16275SDevin Teske# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2287c16275SDevin Teske# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2387c16275SDevin Teske# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2487c16275SDevin Teske# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2587c16275SDevin Teske# SUCH DAMAGE.
2687c16275SDevin Teske#
2787c16275SDevin Teske# $FreeBSD$
2887c16275SDevin Teske#
2987c16275SDevin Teske############################################################ INCLUDES
3087c16275SDevin Teske
3187c16275SDevin TeskeBSDCFG_SHARE="/usr/share/bsdconfig"
3287c16275SDevin Teske. $BSDCFG_SHARE/common.subr || exit 1
3387c16275SDevin Teskef_dprintf "%s: loading includes..." packages/index.subr
3487c16275SDevin Teskef_include $BSDCFG_SHARE/device.subr
3587c16275SDevin Teskef_include $BSDCFG_SHARE/media/common.subr
3687c16275SDevin Teskef_include $BSDCFG_SHARE/strings.subr
3787c16275SDevin Teske
3887c16275SDevin TeskeBSDCFG_LIBE="/usr/libexec/bsdconfig"
3987c16275SDevin Teskef_include_lang $BSDCFG_LIBE/include/messages.subr
4087c16275SDevin Teske
4187c16275SDevin Teske############################################################ GLOBALS
4287c16275SDevin Teske
4387c16275SDevin TeskePACKAGE_INDEX=
4487c16275SDevin Teske_INDEX_INITTED=
4587c16275SDevin Teske
46632d9a08SDevin Teske#
47632d9a08SDevin Teske# Default path to pkg(8) repo-packagesite.sqlite database
48632d9a08SDevin Teske#
49632d9a08SDevin TeskeSQLITE_REPO="/var/db/pkg/repo-packagesite.sqlite"
50632d9a08SDevin Teske
51632d9a08SDevin Teske#
52632d9a08SDevin Teske# Default path to on-disk cache INDEX file
53632d9a08SDevin Teske#
54632d9a08SDevin TeskePACKAGES_INDEX_CACHEFILE="/var/run/bsdconfig/packages_INDEX.cache"
55632d9a08SDevin Teske
56632d9a08SDevin Teske#
57632d9a08SDevin Teske# INDEX format for FreeBSD-6.0 or higher:
58632d9a08SDevin Teske#
59632d9a08SDevin Teske# 	package|port-origin|install-prefix|comment|port-desc-file|maintainer|
60632d9a08SDevin Teske# 	categories|build-deps|run-deps|www-site|reserve|reserve|reserve|disc
61632d9a08SDevin Teske#
62632d9a08SDevin TeskeINDEX_FORMAT="%n-%v" # package
63632d9a08SDevin TeskeINDEX_FORMAT="$INDEX_FORMAT|/usr/ports/%o"	# port-origin
64632d9a08SDevin TeskeINDEX_FORMAT="$INDEX_FORMAT|%p"			# install-prefix
65632d9a08SDevin TeskeINDEX_FORMAT="$INDEX_FORMAT|%c"			# comment
66632d9a08SDevin TeskeINDEX_FORMAT="$INDEX_FORMAT|/usr/ports/%o/pkg-descr"	# port-desc-file
67632d9a08SDevin TeskeINDEX_FORMAT="$INDEX_FORMAT|%m"			# maintainer
68632d9a08SDevin TeskeINDEX_FORMAT="$INDEX_FORMAT|@CATEGORIES@"	# place-holder
69632d9a08SDevin TeskeINDEX_FORMAT="$INDEX_FORMAT|"			# build-deps
70632d9a08SDevin TeskeINDEX_FORMAT="$INDEX_FORMAT|@RUNDEPS@"		# place-holder
71632d9a08SDevin TeskeINDEX_FORMAT="$INDEX_FORMAT|%w"			# www-site
72632d9a08SDevin TeskeINDEX_FORMAT="$INDEX_FORMAT|"			# reserved
73632d9a08SDevin TeskeINDEX_FORMAT="$INDEX_FORMAT|"			# reserved
74632d9a08SDevin TeskeINDEX_FORMAT="$INDEX_FORMAT|"			# reserved
75632d9a08SDevin TeskeINDEX_FORMAT="$INDEX_FORMAT|"			# disc
76632d9a08SDevin Teske
7787c16275SDevin Teske############################################################ FUNCTIONS
7887c16275SDevin Teske
79632d9a08SDevin Teske# f_index_initialize [$var_to_set]
8087c16275SDevin Teske#
81632d9a08SDevin Teske# Read and initialize the global index. Returns success unless media cannot be
82632d9a08SDevin Teske# initialized for any reason (e.g. user cancels media selection dialog or an
83632d9a08SDevin Teske# error occurs). The index is sorted before being loaded into $var_to_set.
8487c16275SDevin Teske#
8587c16275SDevin Teske# NOTE: The index is processed with f_index_read() [below] after being loaded.
8687c16275SDevin Teske#
8787c16275SDevin Teskef_index_initialize()
8887c16275SDevin Teske{
89ee5ef711SDevin Teske	local __funcname=f_index_initialize
90632d9a08SDevin Teske	local __var_to_set="${2:-PACKAGE_INDEX}"
9187c16275SDevin Teske
9287c16275SDevin Teske	[ "$_INDEX_INITTED" ] && return $SUCCESS
9387c16275SDevin Teske
9487c16275SDevin Teske	# Got any media?
9587c16275SDevin Teske	f_media_verify || return $FAILURE
9687c16275SDevin Teske
9787c16275SDevin Teske	# Does it move when you kick it?
98*9ecd54f2SDevin Teske	f_device_init device_media || return $FAILURE
9987c16275SDevin Teske
100632d9a08SDevin Teske	f_show_info "$msg_attempting_to_update_repository_catalogue"
101632d9a08SDevin Teske
102632d9a08SDevin Teske	#
103632d9a08SDevin Teske	# Generate $PACKAGESITE variable for pkg(8) based on media type
104632d9a08SDevin Teske	#
105632d9a08SDevin Teske	local __type __data __site
106632d9a08SDevin Teske	device_media get type __type
107632d9a08SDevin Teske	device_media get private __data
108632d9a08SDevin Teske	case "$__type" in
109ebd672f5SDevin Teske	$DEVICE_TYPE_DIRECTORY)
110ebd672f5SDevin Teske		__site="file://$__data/packages/$PKG_ABI" ;;
111ebd672f5SDevin Teske	$DEVICE_TYPE_FLOPPY)
112ebd672f5SDevin Teske		__site="file://${__data:-$MOUNTPOINT}/packages/$PKG_ABI" ;;
113ebd672f5SDevin Teske	$DEVICE_TYPE_FTP)
114ebd672f5SDevin Teske		f_getvar $VAR_FTP_PATH __site
115ebd672f5SDevin Teske		__site="$__site/packages/$PKG_ABI" ;;
116ebd672f5SDevin Teske	$DEVICE_TYPE_HTTP)
117ebd672f5SDevin Teske		f_getvar $VAR_HTTP_PATH __site
118ebd672f5SDevin Teske		__site="$__site/$PKG_ABI/latest" ;;
119ebd672f5SDevin Teske	$DEVICE_TYPE_HTTP_PROXY)
120ebd672f5SDevin Teske		f_getvar $VAR_HTTP_PROXY_PATH __site
121ebd672f5SDevin Teske		__site="$__site/packages/$PKG_ABI" ;;
122547c099aSGlen Barber	$DEVICE_TYPE_CDROM)
123547c099aSGlen Barber		__site="file://$MOUNTPOINT/packages/$PKG_ABI"
124547c099aSGlen Barber		export REPOS_DIR="$MOUNTPOINT/packages/repos" ;;
125ebd672f5SDevin Teske	*) # UFS, DISK, CDROM, USB, DOS, NFS, etc.
126ebd672f5SDevin Teske		__site="file://$MOUNTPOINT/packages/$PKG_ABI"
127632d9a08SDevin Teske	esac
128632d9a08SDevin Teske
129ee5ef711SDevin Teske	export PACKAGESITE="$__site"
130ee5ef711SDevin Teske	f_dprintf "PACKAGESITE=[%s]" "$PACKAGESITE"
131ee5ef711SDevin Teske	if ! f_eval_catch $__funcname pkg "pkg update"; then
132632d9a08SDevin Teske		f_show_err "$msg_unable_to_update_pkg_from_selected_media"
133*9ecd54f2SDevin Teske		f_device_shutdown device_media
13487c16275SDevin Teske		return $FAILURE
13587c16275SDevin Teske	fi
136632d9a08SDevin Teske
137632d9a08SDevin Teske	#
138632d9a08SDevin Teske	# Try to get contents from validated on-disk cache
139632d9a08SDevin Teske	#
140632d9a08SDevin Teske
141632d9a08SDevin Teske	#
142632d9a08SDevin Teske	# Calculate digest used to determine if the on-disk persistant cache
143632d9a08SDevin Teske	# INDEX (containing this digest on the first line) is valid and can be
144632d9a08SDevin Teske	# used to quickly populate the environment.
145632d9a08SDevin Teske	#
146632d9a08SDevin Teske	local __sqlite_digest
147632d9a08SDevin Teske	if ! __sqlite_digest=$( md5 < "$SQLITE_REPO" 2> /dev/null ); then
148632d9a08SDevin Teske		f_show_err "$msg_no_pkg_database_found"
149*9ecd54f2SDevin Teske		f_device_shutdown device_media
150632d9a08SDevin Teske		return $FAILURE
151632d9a08SDevin Teske	fi
152632d9a08SDevin Teske
153632d9a08SDevin Teske	#
154632d9a08SDevin Teske	# Check to see if the persistant cache INDEX file exists
155632d9a08SDevin Teske	#
156632d9a08SDevin Teske	if [ -f "$PACKAGES_INDEX_CACHEFILE" ]; then
157632d9a08SDevin Teske		#
158632d9a08SDevin Teske		# Attempt to populate the environment with the (soon to be)
159632d9a08SDevin Teske		# validated on-disk cache. If validation fails, fall-back to
160632d9a08SDevin Teske		# generating a fresh cache.
161632d9a08SDevin Teske		#
162632d9a08SDevin Teske		if eval $__var_to_set='$(
163632d9a08SDevin Teske			(	# Get digest as the first word on first line
164632d9a08SDevin Teske				read digest rest_ignored
165632d9a08SDevin Teske
166632d9a08SDevin Teske				#
167632d9a08SDevin Teske				# If the stored digest matches the calculated-
168632d9a08SDevin Teske				# one populate the environment from the on-disk
169632d9a08SDevin Teske				# cache and provide success exit status.
170632d9a08SDevin Teske				#
171632d9a08SDevin Teske				if [ "$digest" = "$__sqlite_digest" ]; then
172632d9a08SDevin Teske					cat
173632d9a08SDevin Teske					exit $SUCCESS
174632d9a08SDevin Teske				else
175632d9a08SDevin Teske					# Otherwise, return the current value
176632d9a08SDevin Teske					eval echo \"\$__var_to_set\"
177632d9a08SDevin Teske					exit $FAILURE
178632d9a08SDevin Teske				fi
179632d9a08SDevin Teske			) < "$PACKAGES_INDEX_CACHEFILE" 2> /dev/null
180632d9a08SDevin Teske		)'; then
181632d9a08SDevin Teske			f_show_info \
182632d9a08SDevin Teske			  "$msg_located_index_now_reading_package_data_from_it"
183632d9a08SDevin Teske			if ! f_index_read "$__var_to_set"; then
184632d9a08SDevin Teske				f_show_err \
185632d9a08SDevin Teske					"$msg_io_or_format_error_on_index_file"
186632d9a08SDevin Teske				return $FAILURE
187632d9a08SDevin Teske			fi
188632d9a08SDevin Teske			_INDEX_INITTED=1
189632d9a08SDevin Teske			return $SUCCESS
190632d9a08SDevin Teske		fi
191632d9a08SDevin Teske		# Otherwise, fall-thru to create a fresh cache from scratch
192632d9a08SDevin Teske	fi
193632d9a08SDevin Teske
194632d9a08SDevin Teske	#
195632d9a08SDevin Teske	# If we reach this point, we need to generate the data from scratch
196632d9a08SDevin Teske	#
197632d9a08SDevin Teske
198632d9a08SDevin Teske	f_show_info "$msg_getting_package_categories_via_pkg_rquery"
199632d9a08SDevin Teske	if ! eval "$( pkg rquery "%n-%v %C" | awk '
200632d9a08SDevin Teske	{ categories[$1] = categories[$1] " " $2 }
201632d9a08SDevin Teske	END {
202632d9a08SDevin Teske		for (package in categories)
203632d9a08SDevin Teske		{
204632d9a08SDevin Teske			cats = categories[package]
205632d9a08SDevin Teske			sub(/^ /, "", cats)
206632d9a08SDevin Teske			gsub(/[^[:alnum:]_]/, "_", package)
207632d9a08SDevin Teske			printf "local _%s_categories=\"%s\";\n", package, cats
208632d9a08SDevin Teske		}
209632d9a08SDevin Teske	}' )"; then
2106451dd7eSDevin Teske		f_show_err "$msg_unable_to_pkg_rquery_package_dependencies"
211*9ecd54f2SDevin Teske		f_device_shutdown device_media
212632d9a08SDevin Teske		return $FAILURE
213632d9a08SDevin Teske	fi
214632d9a08SDevin Teske
215632d9a08SDevin Teske	f_show_info "$msg_getting_package_dependencies_via_pkg_rquery"
216632d9a08SDevin Teske	if ! eval "$( pkg rquery "%n-%v %dn-%dv" | awk '
217632d9a08SDevin Teske	{ rundeps[$1] = rundeps[$1] " " $2 }
218632d9a08SDevin Teske	END {
219632d9a08SDevin Teske		for (package in rundeps)
220632d9a08SDevin Teske		{
221632d9a08SDevin Teske			deps = rundeps[package]
222632d9a08SDevin Teske			sub(/^ /, "", deps)
223632d9a08SDevin Teske			gsub(/[^[:alnum:]_]/, "_", package)
224632d9a08SDevin Teske			printf "local _%s_rundeps=\"%s\";\n", package, deps
225632d9a08SDevin Teske		}
226632d9a08SDevin Teske	}' )"; then
2276451dd7eSDevin Teske		f_show_err "$msg_unable_to_pkg_rquery_package_dependencies"
228*9ecd54f2SDevin Teske		f_device_shutdown device_media
229632d9a08SDevin Teske		return $FAILURE
230632d9a08SDevin Teske	fi
231632d9a08SDevin Teske
232632d9a08SDevin Teske	f_show_info "$msg_generating_index_from_pkg_database"
233632d9a08SDevin Teske	eval "$__var_to_set"='$( pkg rquery "$INDEX_FORMAT" |
234632d9a08SDevin Teske		while read LINE; do
235632d9a08SDevin Teske			package="${LINE%%|*}";
236632d9a08SDevin Teske			f_str2varname "$package" varpkg;
237632d9a08SDevin Teske			eval f_replaceall \"\$LINE\" \"\|@CATEGORIES@\|\" \
238632d9a08SDevin Teske				\"\|\$_${varpkg}_categories\|\" LINE
239632d9a08SDevin Teske			eval f_replaceall \"\$LINE\" \"\|@RUNDEPS@\|\" \
240632d9a08SDevin Teske				\"\|\$_${varpkg}_rundeps\|\" LINE
241632d9a08SDevin Teske			echo "$LINE"
242632d9a08SDevin Teske		done
243632d9a08SDevin Teske	)' # always returns true (status of last item in pipe-chain)
244e4cb6ac1SDevin Teske	eval "$__var_to_set"='$( debug= f_getvar "$__var_to_set" | sort )'
24587c16275SDevin Teske
246632d9a08SDevin Teske	#
247632d9a08SDevin Teske	# Attempt to create the persistant on-disk cache
248632d9a08SDevin Teske	#
249632d9a08SDevin Teske
250632d9a08SDevin Teske	# Create a new temporary file to write to
251d4ae33f0SDevin Teske	local __tmpfile
252d4ae33f0SDevin Teske	if f_eval_catch -dk __tmpfile $__funcname mktemp \
253d4ae33f0SDevin Teske		'mktemp -t "%s"' "$pgm"
254d4ae33f0SDevin Teske	then
255632d9a08SDevin Teske		# Write the temporary file contents
256632d9a08SDevin Teske		echo "$__sqlite_digest" > "$__tmpfile"
257632d9a08SDevin Teske		debug= f_getvar "$__var_to_set" >> "$__tmpfile"
258632d9a08SDevin Teske
259632d9a08SDevin Teske		# Finally, move the temporary file into place
260632d9a08SDevin Teske		case "$PACKAGES_INDEX_CACHEFILE" in
261d4ae33f0SDevin Teske		*/*) f_eval_catch -d $funcname mkdir \
262d4ae33f0SDevin Teske			'mkdir -p "%s"' "${PACKAGES_INDEX_CACHEFILE%/*}"
263632d9a08SDevin Teske		esac
264d4ae33f0SDevin Teske		f_eval_catch -d $__funcname mv 'mv -f "%s" "%s"' \
265d4ae33f0SDevin Teske			"$__tmpfile" "$PACKAGES_INDEX_CACHEFILE"
266632d9a08SDevin Teske	fi
267632d9a08SDevin Teske
26887c16275SDevin Teske	f_show_info "$msg_located_index_now_reading_package_data_from_it"
26987c16275SDevin Teske	if ! f_index_read "$__var_to_set"; then
270632d9a08SDevin Teske		f_show_err "$msg_io_or_format_error_on_index_file"
27187c16275SDevin Teske		return $FAILURE
27287c16275SDevin Teske	fi
27387c16275SDevin Teske
27487c16275SDevin Teske	_INDEX_INITTED=1
27587c16275SDevin Teske	return $SUCCESS
27687c16275SDevin Teske}
27787c16275SDevin Teske
27887c16275SDevin Teske# f_index_read [$var_to_get]
27987c16275SDevin Teske#
28087c16275SDevin Teske# Process the INDEX file (contents contained in $var_to_get) and...
28187c16275SDevin Teske#
28287c16275SDevin Teske# 1. create a list ($CATEGORY_MENU_LIST) of categories with package counts
28387c16275SDevin Teske# 2. For convenience, create $_npkgs holding the total number of all packages
28487c16275SDevin Teske# 3. extract associative categories for each package into $_categories_$varpkg
28587c16275SDevin Teske# 4. extract runtime dependencies for each package into $_rundeps_$varpkg
28687c16275SDevin Teske# 5. extract a [sorted] list of categories into $PACKAGE_CATEGORIES
28787c16275SDevin Teske# 6. create $_npkgs_$varcat holding the total number of packages in category
28887c16275SDevin Teske#
28987c16275SDevin Teske# NOTE: $varpkg is the product of f_str2varname $package varpkg
29087c16275SDevin Teske# NOTE: $package is the name as it appears in the INDEX (no archive suffix)
29187c16275SDevin Teske# NOTE: We only show categories for which there are at least one package.
29287c16275SDevin Teske# NOTE: $varcat is the product of f_str2varname $category varcat
29387c16275SDevin Teske#
29487c16275SDevin Teskef_index_read()
29587c16275SDevin Teske{
29687c16275SDevin Teske	local var_to_get="${1:-PACKAGE_INDEX}"
29787c16275SDevin Teske
29887c16275SDevin Teske	# Export variables required by awk(1) below
29987c16275SDevin Teske	export msg_no_description_provided
30087c16275SDevin Teske	export msg_all msg_all_desc
30187c16275SDevin Teske	export VALID_VARNAME_CHARS
3025cf9b06bSDevin Teske	export msg_packages
30387c16275SDevin Teske
30487c16275SDevin Teske	eval "$( debug= f_getvar "$var_to_get" | awk -F'|' '
30587c16275SDevin Teske	function asorti(src, dest)
30687c16275SDevin Teske	{
30787c16275SDevin Teske		# Copy src indices to dest and calculate array length
30887c16275SDevin Teske		nitems = 0; for (i in src) dest[++nitems] = i
30987c16275SDevin Teske
31087c16275SDevin Teske		# Sort the array of indices (dest) using insertion sort method
31187c16275SDevin Teske		for (i = 1; i <= nitems; k = i++)
31287c16275SDevin Teske		{
31387c16275SDevin Teske			idx = dest[i]
31487c16275SDevin Teske			while ((k > 0) && (dest[k] > idx))
31587c16275SDevin Teske			{
31687c16275SDevin Teske				dest[k+1] = dest[k]
31787c16275SDevin Teske				k--
31887c16275SDevin Teske			}
31987c16275SDevin Teske			dest[k+1] = idx
32087c16275SDevin Teske		}
32187c16275SDevin Teske
32287c16275SDevin Teske		return nitems
32387c16275SDevin Teske	}
32487c16275SDevin Teske	function print_category(category, npkgs, desc)
32587c16275SDevin Teske	{
32687c16275SDevin Teske		cat = category
32787c16275SDevin Teske		# Accent the category if the first page has been
32887c16275SDevin Teske		# cached (also acting as a visitation indicator)
32987c16275SDevin Teske		if ( ENVIRON["_index_page_" varcat "_1"] )
33087c16275SDevin Teske			cat = cat "*"
3315cf9b06bSDevin Teske		printf "'\''%s'\'' '\''%s " packages "'\'' '\''%s'\''\n",
33287c16275SDevin Teske		       cat, npkgs, desc
33387c16275SDevin Teske	}
33487c16275SDevin Teske	BEGIN {
33587c16275SDevin Teske		valid_chars = ENVIRON["VALID_VARNAME_CHARS"]
33687c16275SDevin Teske		default_desc = ENVIRON["msg_no_description_provided"]
3375cf9b06bSDevin Teske		packages = ENVIRON["msg_packages"]
338a28232e3SDevin Teske		tpkgs = 0
33987c16275SDevin Teske		prefix = ""
34087c16275SDevin Teske	}
34187c16275SDevin Teske	{
342a28232e3SDevin Teske		tpkgs++
34387c16275SDevin Teske		varpkg = $1
34487c16275SDevin Teske		gsub("[^" valid_chars "]", "_", varpkg)
34587c16275SDevin Teske		print "_categories_" varpkg "=\"" $7 "\""
34687c16275SDevin Teske		split($7, pkg_categories, /[[:space:]]+/)
34787c16275SDevin Teske		for (pkg_category in pkg_categories)
34887c16275SDevin Teske			categories[pkg_categories[pkg_category]]++
34987c16275SDevin Teske		print "_rundeps_" varpkg "=\"" $9 "\""
35087c16275SDevin Teske	}
35187c16275SDevin Teske	END {
352a28232e3SDevin Teske		print "_npkgs=" tpkgs # For convenience, total package count
35387c16275SDevin Teske
35487c16275SDevin Teske		n = asorti(categories, categories_sorted)
35587c16275SDevin Teske
35687c16275SDevin Teske		# Produce package counts for each category
35787c16275SDevin Teske		for (i = 1; i <= n; i++)
35887c16275SDevin Teske		{
35987c16275SDevin Teske			cat = varcat = categories_sorted[i]
36087c16275SDevin Teske			npkgs = categories[cat]
36187c16275SDevin Teske			gsub("[^" valid_chars "]", "_", varcat)
36287c16275SDevin Teske			print "_npkgs_" varcat "=\"" npkgs "\""
36387c16275SDevin Teske		}
36487c16275SDevin Teske
36587c16275SDevin Teske		# Create menu list and generate list of categories at same time
36687c16275SDevin Teske		print "CATEGORY_MENU_LIST=\""
367a28232e3SDevin Teske		print_category(ENVIRON["msg_all"], tpkgs,
36887c16275SDevin Teske		               ENVIRON["msg_all_desc"])
36987c16275SDevin Teske		category_list = ""
37087c16275SDevin Teske		for (i = 1; i <= n; i++)
37187c16275SDevin Teske		{
37287c16275SDevin Teske			cat = varcat = categories_sorted[i]
37387c16275SDevin Teske			npkgs = categories[cat]
37487c16275SDevin Teske			cur_prefix = tolower(substr(cat, 1, 1))
37587c16275SDevin Teske			if ( prefix != cur_prefix )
37687c16275SDevin Teske				prefix = cur_prefix
37787c16275SDevin Teske			else
37887c16275SDevin Teske				cat = " " cat
37987c16275SDevin Teske			gsub("[^" valid_chars "]", "_", varcat)
38087c16275SDevin Teske			desc = ENVIRON["_category_" varcat]
38187c16275SDevin Teske			if ( ! desc ) desc = default_desc
38287c16275SDevin Teske			print_category(cat, npkgs, desc)
38387c16275SDevin Teske			category_list = category_list " " cat
38487c16275SDevin Teske		}
38587c16275SDevin Teske		print "\""
38687c16275SDevin Teske
38787c16275SDevin Teske		# Produce the list of categories (calculated in above block)
38887c16275SDevin Teske		sub(/^ /, "", category_list)
38987c16275SDevin Teske		print "PACKAGE_CATEGORIES=\"" category_list "\""
39087c16275SDevin Teske
39187c16275SDevin Teske	}' )" # End-Quote
39287c16275SDevin Teske}
39387c16275SDevin Teske
39487c16275SDevin Teske# f_index_extract_pages $var_to_get $var_basename $pagesize [$category]
39587c16275SDevin Teske#
39676ab5f3dSDevin Teske# Extracts the package INDEX ($PACKAGE_INDEX by default if/when $var_to_get is
39776ab5f3dSDevin Teske# NULL; but should not be missing) into a series of sequential variables
39887c16275SDevin Teske# corresponding to "pages" containing up to $pagesize packages. The package
39987c16275SDevin Teske# INDEX data must be contained in the variable $var_to_get. The extracted pages
40087c16275SDevin Teske# are stored in variables ${var_basename}_# -- where "#" is a the page number.
40187c16275SDevin Teske# If $category is set, only packages for that category are extracted.
40287c16275SDevin Teske# Otherwise, if $category is "All", missing, or NULL, all packages are
40387c16275SDevin Teske# extracted and no filtering is done.
40487c16275SDevin Teske#
40587c16275SDevin Teskef_index_extract_pages()
40687c16275SDevin Teske{
40776ab5f3dSDevin Teske	local var_to_get="${1:-PACKAGE_INDEX}" var_basename="$2" pagesize="$3"
40887c16275SDevin Teske	local category="$4" # Optional
40987c16275SDevin Teske
41087c16275SDevin Teske	eval "$(
41187c16275SDevin Teske		debug= f_getvar "$var_to_get" | awk -F'|' \
41287c16275SDevin Teske			-v cat="$category" \
41387c16275SDevin Teske			-v pagesize="$pagesize" \
4145cf9b06bSDevin Teske			-v var_basename="$var_basename" \
4155cf9b06bSDevin Teske			-v i18n_all="$msg_all" '
41687c16275SDevin Teske		BEGIN { n = page = 0 }
41787c16275SDevin Teske		/'\''/{ gsub(/'\''/, "'\''\\'\'\''") }
41887c16275SDevin Teske		{
4195cf9b06bSDevin Teske			if ( cat !~ "(^$|^" i18n_all "$)" && $7 !~ \
42087c16275SDevin Teske			     "(^|[[:space:]])" cat "([[:space:]]|$)" ) next
42187c16275SDevin Teske			starting_new_page = (n++ == (pagesize * page))
42287c16275SDevin Teske			if ( starting_new_page )
42387c16275SDevin Teske				printf "%s%s", ( n > 1 ? "'\''\n" : "" ),
42487c16275SDevin Teske				       var_basename "_" ++page "='\''"
42587c16275SDevin Teske			printf "%s%s", ( starting_new_page ? "" : "\n" ), $0
42687c16275SDevin Teske		}
42787c16275SDevin Teske		END { if ( n > 0 ) print "'\''" }'
42887c16275SDevin Teske	)"
42987c16275SDevin Teske}
43087c16275SDevin Teske
43131185df0SDevin Teske# f_index_search $var_to_get $name [$var_to_set]
43231185df0SDevin Teske#
43360fefd1eSDevin Teske# Search the package INDEX ($PACKAGE_INDEX by default if/when $var_to_get is
43431185df0SDevin Teske# NULL; but should not be missing) for $name, returning the first match.
43531185df0SDevin Teske# Matches are strict (not regular expressions) and must match the beginning
43631185df0SDevin Teske# portion of the package name to be considered a match. If $var_to_set is
43731185df0SDevin Teske# missing or NULL, output is sent to standard output. If a match is found,
43831185df0SDevin Teske# returns success; otherwise failure.
43931185df0SDevin Teske#
44031185df0SDevin Teskef_index_search()
44131185df0SDevin Teske{
44231185df0SDevin Teske	local __var_to_get="${1:-PACKAGE_INDEX}" __pkg_basename="$2"
44331185df0SDevin Teske	local __var_to_set="$3"
44431185df0SDevin Teske
44531185df0SDevin Teske	f_dprintf "f_index_search: Searching package data (in %s) for %s" \
44631185df0SDevin Teske	          "$__var_to_get" "$__pkg_basename"
44731185df0SDevin Teske
44831185df0SDevin Teske	local __pkg=
44931185df0SDevin Teske	__pkg=$( debug= f_getvar "$__var_to_get" |
45031185df0SDevin Teske			awk -F'|' -v basename="$__pkg_basename" '
45131185df0SDevin Teske		BEGIN { n = length(basename) }
45231185df0SDevin Teske		substr($1, 0, n) == basename { print $1; exit }
45331185df0SDevin Teske	' )
45431185df0SDevin Teske	if [ ! "$__pkg" ]; then
45531185df0SDevin Teske		f_dprintf "f_index_search: No packages matching %s found" \
45631185df0SDevin Teske		          "$__pkg_basename"
45731185df0SDevin Teske		return $FAILURE
45831185df0SDevin Teske	fi
45931185df0SDevin Teske
46031185df0SDevin Teske	f_dprintf "f_index_search: Found package %s" "$__pkg"
46131185df0SDevin Teske	if [ "$__var_to_set" ]; then
46231185df0SDevin Teske		setvar "$__var_to_set" "$__pkg"
46331185df0SDevin Teske	else
46431185df0SDevin Teske		echo "$__pkg"
46531185df0SDevin Teske	fi
46631185df0SDevin Teske	return $SUCCESS
46731185df0SDevin Teske}
46831185df0SDevin Teske
46987c16275SDevin Teske############################################################ MAIN
47087c16275SDevin Teske
47187c16275SDevin Teskef_dprintf "%s: Successfully loaded." packages/index.subr
47287c16275SDevin Teske
47387c16275SDevin Teskefi # ! $_PACKAGES_INDEX_SUBR
474