/[gentoo-x86]/eclass/eutils.eclass
Gentoo

Diff of /eclass/eutils.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.304 Revision 1.386
1# Copyright 1999-2007 Gentoo Foundation 1# Copyright 1999-2012 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.304 2008/09/20 18:45:26 vapier Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.386 2012/03/01 22:10:50 naota Exp $
4 4
5# @ECLASS: eutils.eclass 5# @ECLASS: eutils.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# base-system@gentoo.org 7# base-system@gentoo.org
8# @BLURB: many extra (but common) functions that are used in ebuilds 8# @BLURB: many extra (but common) functions that are used in ebuilds
13# home rather than having multiple ebuilds implementing the same thing. 13# home rather than having multiple ebuilds implementing the same thing.
14# 14#
15# Due to the nature of this eclass, some functions may have maintainers 15# Due to the nature of this eclass, some functions may have maintainers
16# different from the overall eclass! 16# different from the overall eclass!
17 17
18inherit multilib portability 18if [[ ${___ECLASS_ONCE_EUTILS} != "recur -_+^+_- spank" ]] ; then
19___ECLASS_ONCE_EUTILS="recur -_+^+_- spank"
20
21inherit multilib user
19 22
20DESCRIPTION="Based on the ${ECLASS} eclass" 23DESCRIPTION="Based on the ${ECLASS} eclass"
24
25if has "${EAPI:-0}" 0 1 2; then
21 26
22# @FUNCTION: epause 27# @FUNCTION: epause
23# @USAGE: [seconds] 28# @USAGE: [seconds]
24# @DESCRIPTION: 29# @DESCRIPTION:
25# Sleep for the specified number of seconds (default of 5 seconds). Useful when 30# Sleep for the specified number of seconds (default of 5 seconds). Useful when
26# printing a message the user should probably be reading and often used in 31# printing a message the user should probably be reading and often used in
27# conjunction with the ebeep function. If the EPAUSE_IGNORE env var is set, 32# conjunction with the ebeep function. If the EPAUSE_IGNORE env var is set,
28# don't wait at all. 33# don't wait at all. Defined in EAPIs 0 1 and 2.
29epause() { 34epause() {
30 [[ -z ${EPAUSE_IGNORE} ]] && sleep ${1:-5} 35 [[ -z ${EPAUSE_IGNORE} ]] && sleep ${1:-5}
31} 36}
32 37
33# @FUNCTION: ebeep 38# @FUNCTION: ebeep
34# @USAGE: [number of beeps] 39# @USAGE: [number of beeps]
35# @DESCRIPTION: 40# @DESCRIPTION:
36# Issue the specified number of beeps (default of 5 beeps). Useful when 41# Issue the specified number of beeps (default of 5 beeps). Useful when
37# printing a message the user should probably be reading and often used in 42# printing a message the user should probably be reading and often used in
38# conjunction with the epause function. If the EBEEP_IGNORE env var is set, 43# conjunction with the epause function. If the EBEEP_IGNORE env var is set,
39# don't beep at all. 44# don't beep at all. Defined in EAPIs 0 1 and 2.
40ebeep() { 45ebeep() {
41 local n 46 local n
42 if [[ -z ${EBEEP_IGNORE} ]] ; then 47 if [[ -z ${EBEEP_IGNORE} ]] ; then
43 for ((n=1 ; n <= ${1:-5} ; n++)) ; do 48 for ((n=1 ; n <= ${1:-5} ; n++)) ; do
44 echo -ne "\a" 49 echo -ne "\a"
47 sleep 1 52 sleep 1
48 done 53 done
49 fi 54 fi
50} 55}
51 56
57else
58
59ebeep() {
60 ewarn "QA Notice: ebeep is not defined in EAPI=${EAPI}, please file a bug at http://bugs.gentoo.org"
61}
62
63epause() {
64 ewarn "QA Notice: epause is not defined in EAPI=${EAPI}, please file a bug at http://bugs.gentoo.org"
65}
66
67fi
68
69# @FUNCTION: eqawarn
70# @USAGE: [message]
71# @DESCRIPTION:
72# Proxy to ewarn for package managers that don't provide eqawarn and use the PM
73# implementation if available. Reuses PORTAGE_ELOG_CLASSES as set by the dev
74# profile.
75if ! declare -F eqawarn >/dev/null ; then
76 eqawarn() {
77 has qa ${PORTAGE_ELOG_CLASSES} && ewarn "$@"
78 :
79 }
80fi
81
52# @FUNCTION: ecvs_clean 82# @FUNCTION: ecvs_clean
53# @USAGE: [list of dirs] 83# @USAGE: [list of dirs]
54# @DESCRIPTION: 84# @DESCRIPTION:
55# Remove CVS directories recursiveley. Useful when a source tarball contains 85# Remove CVS directories recursiveley. Useful when a source tarball contains
56# internal CVS directories. Defaults to $PWD. 86# internal CVS directories. Defaults to $PWD.
68esvn_clean() { 98esvn_clean() {
69 [[ -z $* ]] && set -- . 99 [[ -z $* ]] && set -- .
70 find "$@" -type d -name '.svn' -prune -print0 | xargs -0 rm -rf 100 find "$@" -type d -name '.svn' -prune -print0 | xargs -0 rm -rf
71} 101}
72 102
73# Default directory where patches are located 103# @FUNCTION: estack_push
104# @USAGE: <stack> [items to push]
105# @DESCRIPTION:
106# Push any number of items onto the specified stack. Pick a name that
107# is a valid variable (i.e. stick to alphanumerics), and push as many
108# items as you like onto the stack at once.
109#
110# The following code snippet will echo 5, then 4, then 3, then ...
111# @CODE
112# estack_push mystack 1 2 3 4 5
113# while estack_pop mystack i ; do
114# echo "${i}"
115# done
116# @CODE
117estack_push() {
118 [[ $# -eq 0 ]] && die "estack_push: incorrect # of arguments"
119 local stack_name="__ESTACK_$1__" ; shift
120 eval ${stack_name}+=\( \"\$@\" \)
121}
122
123# @FUNCTION: estack_pop
124# @USAGE: <stack> [variable]
125# @DESCRIPTION:
126# Pop a single item off the specified stack. If a variable is specified,
127# the popped item is stored there. If no more items are available, return
128# 1, else return 0. See estack_push for more info.
129estack_pop() {
130 [[ $# -eq 0 || $# -gt 2 ]] && die "estack_pop: incorrect # of arguments"
131
132 # We use the fugly __estack_xxx var names to avoid collision with
133 # passing back the return value. If we used "local i" and the
134 # caller ran `estack_pop ... i`, we'd end up setting the local
135 # copy of "i" rather than the caller's copy. The __estack_xxx
136 # garbage is preferable to using $1/$2 everywhere as that is a
137 # bit harder to read.
138 local __estack_name="__ESTACK_$1__" ; shift
139 local __estack_retvar=$1 ; shift
140 eval local __estack_i=\${#${__estack_name}\[@\]}
141 # Don't warn -- let the caller interpret this as a failure
142 # or as normal behavior (akin to `shift`)
143 [[ $(( --__estack_i )) -eq -1 ]] && return 1
144
145 if [[ -n ${__estack_retvar} ]] ; then
146 eval ${__estack_retvar}=\"\${${__estack_name}\[${__estack_i}\]}\"
147 fi
148 eval unset ${__estack_name}\[${__estack_i}\]
149}
150
151# @FUNCTION: eshopts_push
152# @USAGE: [options to `set` or `shopt`]
153# @DESCRIPTION:
154# Often times code will want to enable a shell option to change code behavior.
155# Since changing shell options can easily break other pieces of code (which
156# assume the default state), eshopts_push is used to (1) push the current shell
157# options onto a stack and (2) pass the specified arguments to set.
158#
159# If the first argument is '-s' or '-u', we assume you want to call `shopt`
160# rather than `set` as there are some options only available via that.
161#
162# A common example is to disable shell globbing so that special meaning/care
163# may be used with variables/arguments to custom functions. That would be:
164# @CODE
165# eshopts_push -s noglob
166# for x in ${foo} ; do
167# if ...some check... ; then
168# eshopts_pop
169# return 0
170# fi
171# done
172# eshopts_pop
173# @CODE
174eshopts_push() {
175 if [[ $1 == -[su] ]] ; then
176 estack_push eshopts "$(shopt -p)"
177 [[ $# -eq 0 ]] && return 0
178 shopt "$@" || die "${FUNCNAME}: bad options to shopt: $*"
179 else
180 estack_push eshopts $-
181 [[ $# -eq 0 ]] && return 0
182 set "$@" || die "${FUNCNAME}: bad options to set: $*"
183 fi
184}
185
186# @FUNCTION: eshopts_pop
187# @USAGE:
188# @DESCRIPTION:
189# Restore the shell options to the state saved with the corresponding
190# eshopts_push call. See that function for more details.
191eshopts_pop() {
192 local s
193 estack_pop eshopts s || die "${FUNCNAME}: unbalanced push"
194 if [[ ${s} == "shopt -"* ]] ; then
195 eval "${s}" || die "${FUNCNAME}: sanity: invalid shopt options: ${s}"
196 else
197 set +$- || die "${FUNCNAME}: sanity: invalid shell settings: $-"
198 set -${s} || die "${FUNCNAME}: sanity: unable to restore saved shell settings: ${s}"
199 fi
200}
201
202# @FUNCTION: eumask_push
203# @USAGE: <new umask>
204# @DESCRIPTION:
205# Set the umask to the new value specified while saving the previous
206# value onto a stack. Useful for temporarily changing the umask.
207eumask_push() {
208 estack_push eumask "$(umask)"
209 umask "$@" || die "${FUNCNAME}: bad options to umask: $*"
210}
211
212# @FUNCTION: eumask_pop
213# @USAGE:
214# @DESCRIPTION:
215# Restore the previous umask state.
216eumask_pop() {
217 [[ $# -eq 0 ]] || die "${FUNCNAME}: we take no options"
218 local s
219 estack_pop eumask s || die "${FUNCNAME}: unbalanced push"
220 umask ${s} || die "${FUNCNAME}: sanity: could not restore umask: ${s}"
221}
222
223# @VARIABLE: EPATCH_SOURCE
224# @DESCRIPTION:
225# Default directory to search for patches.
74EPATCH_SOURCE="${WORKDIR}/patch" 226EPATCH_SOURCE="${WORKDIR}/patch"
75# Default extension for patches 227# @VARIABLE: EPATCH_SUFFIX
228# @DESCRIPTION:
229# Default extension for patches (do not prefix the period yourself).
76EPATCH_SUFFIX="patch.bz2" 230EPATCH_SUFFIX="patch.bz2"
231# @VARIABLE: EPATCH_OPTS
232# @DESCRIPTION:
77# Default options for patch 233# Default options for patch:
234# @CODE
78# Set -g0 to keep RCS, ClearCase, Perforce and SCCS happy. Bug #24571 235# -g0 - keep RCS, ClearCase, Perforce and SCCS happy #24571
79# Set --no-backup-if-mismatch so we don't leave '.orig' files behind. 236# --no-backup-if-mismatch - do not leave .orig files behind
80# Set -E to automatically remove empty files. 237# -E - automatically remove empty files
238# @CODE
81EPATCH_OPTS="-g0 -E --no-backup-if-mismatch" 239EPATCH_OPTS="-g0 -E --no-backup-if-mismatch"
240# @VARIABLE: EPATCH_EXCLUDE
241# @DESCRIPTION:
82# List of patches not to apply. Not this is only file names, 242# List of patches not to apply. Note this is only file names,
83# and not the full path .. 243# and not the full path. Globs accepted.
84EPATCH_EXCLUDE="" 244EPATCH_EXCLUDE=""
245# @VARIABLE: EPATCH_SINGLE_MSG
246# @DESCRIPTION:
85# Change the printed message for a single patch. 247# Change the printed message for a single patch.
86EPATCH_SINGLE_MSG="" 248EPATCH_SINGLE_MSG=""
249# @VARIABLE: EPATCH_MULTI_MSG
250# @DESCRIPTION:
87# Change the printed message for multiple patches. 251# Change the printed message for multiple patches.
88EPATCH_MULTI_MSG="Applying various patches (bugfixes/updates) ..." 252EPATCH_MULTI_MSG="Applying various patches (bugfixes/updates) ..."
89# Force applying bulk patches even if not following the style: 253# @VARIABLE: EPATCH_FORCE
90# 254# @DESCRIPTION:
91# ??_${ARCH}_foo.${EPATCH_SUFFIX} 255# Only require patches to match EPATCH_SUFFIX rather than the extended
92# 256# arch naming style.
93EPATCH_FORCE="no" 257EPATCH_FORCE="no"
94 258
95# This function is for bulk patching, or in theory for just one 259# @FUNCTION: epatch
96# or two patches. 260# @USAGE: [patches] [dirs of patches]
261# @DESCRIPTION:
262# epatch is designed to greatly simplify the application of patches. It can
263# process patch files directly, or directories of patches. The patches may be
264# compressed (bzip/gzip/etc...) or plain text. You generally need not specify
265# the -p option as epatch will automatically attempt -p0 to -p5 until things
266# apply successfully.
97# 267#
98# It should work with .bz2, .gz, .zip and plain text patches. 268# If you do not specify any options, then epatch will default to the directory
99# Currently all patches should be the same format. 269# specified by EPATCH_SOURCE.
100# 270#
101# You do not have to specify '-p' option to patch, as it will 271# When processing directories, epatch will apply all patches that match:
102# try with -p0 to -p5 until it succeed, or fail at -p5. 272# @CODE
103# 273# if ${EPATCH_FORCE} != "yes"
104# Above EPATCH_* variables can be used to control various defaults,
105# bug they should be left as is to ensure an ebuild can rely on
106# them for.
107#
108# Patches are applied in current directory.
109#
110# Bulk Patches should preferibly have the form of:
111#
112# ??_${ARCH}_foo.${EPATCH_SUFFIX} 274# ??_${ARCH}_foo.${EPATCH_SUFFIX}
275# else
276# *.${EPATCH_SUFFIX}
277# @CODE
278# The leading ?? are typically numbers used to force consistent patch ordering.
279# The arch field is used to apply patches only for the host architecture with
280# the special value of "all" means apply for everyone. Note that using values
281# other than "all" is highly discouraged -- you should apply patches all the
282# time and let architecture details be detected at configure/compile time.
113# 283#
114# For example: 284# If EPATCH_SUFFIX is empty, then no period before it is implied when searching
285# for patches to apply.
115# 286#
116# 01_all_misc-fix.patch.bz2 287# Refer to the other EPATCH_xxx variables for more customization of behavior.
117# 02_sparc_another-fix.patch.bz2
118#
119# This ensures that there are a set order, and you can have ARCH
120# specific patches.
121#
122# If you however give an argument to epatch(), it will treat it as a
123# single patch that need to be applied if its a file. If on the other
124# hand its a directory, it will set EPATCH_SOURCE to this.
125#
126# <azarah@gentoo.org> (10 Nov 2002)
127#
128epatch() { 288epatch() {
129 _epatch_draw_line() { 289 _epatch_draw_line() {
290 # create a line of same length as input string
130 [[ -z $1 ]] && set "$(printf "%65s" '')" 291 [[ -z $1 ]] && set "$(printf "%65s" '')"
131 echo "${1//?/=}" 292 echo "${1//?/=}"
132 } 293 }
133 _epatch_assert() { local _pipestatus=${PIPESTATUS[*]}; [[ ${_pipestatus// /} -eq 0 ]] ; }
134 local PIPE_CMD=""
135 local STDERR_TARGET="${T}/$$.out"
136 local PATCH_TARGET="${T}/$$.patch"
137 local PATCH_SUFFIX=""
138 local SINGLE_PATCH="no"
139 local x=""
140 294
141 unset P4CONFIG P4PORT P4USER # keep perforce at bay #56402 295 unset P4CONFIG P4PORT P4USER # keep perforce at bay #56402
142 296
143 if [ "$#" -gt 1 ] 297 # Let the rest of the code process one user arg at a time --
144 then 298 # each arg may expand into multiple patches, and each arg may
299 # need to start off with the default global EPATCH_xxx values
300 if [[ $# -gt 1 ]] ; then
145 local m="" 301 local m
146 for m in "$@" ; do 302 for m in "$@" ; do
147 epatch "${m}" 303 epatch "${m}"
148 done 304 done
149 return 0 305 return 0
150 fi 306 fi
151 307
152 if [ -n "$1" -a -f "$1" ] 308 local SINGLE_PATCH="no"
153 then 309 # no args means process ${EPATCH_SOURCE}
310 [[ $# -eq 0 ]] && set -- "${EPATCH_SOURCE}"
311
312 if [[ -f $1 ]] ; then
154 SINGLE_PATCH="yes" 313 SINGLE_PATCH="yes"
155 314 set -- "$1"
156 local EPATCH_SOURCE="$1" 315 # Use the suffix from the single patch (localize it); the code
316 # below will find the suffix for us
157 local EPATCH_SUFFIX="${1##*\.}" 317 local EPATCH_SUFFIX=$1
158 318
159 elif [ -n "$1" -a -d "$1" ] 319 elif [[ -d $1 ]] ; then
160 then 320 # Some people like to make dirs of patches w/out suffixes (vim)
161 # Allow no extension if EPATCH_FORCE=yes ... used by vim for example ... 321 set -- "$1"/*${EPATCH_SUFFIX:+."${EPATCH_SUFFIX}"}
162 if [ "${EPATCH_FORCE}" = "yes" ] && [ -z "${EPATCH_SUFFIX}" ] 322
323 elif [[ -f ${EPATCH_SOURCE}/$1 ]] ; then
324 # Re-use EPATCH_SOURCE as a search dir
325 epatch "${EPATCH_SOURCE}/$1"
326 return $?
327
328 else
329 # sanity check ... if it isn't a dir or file, wtf man ?
330 [[ $# -ne 0 ]] && EPATCH_SOURCE=$1
331 echo
332 eerror "Cannot find \$EPATCH_SOURCE! Value for \$EPATCH_SOURCE is:"
333 eerror
334 eerror " ${EPATCH_SOURCE}"
335 eerror " ( ${EPATCH_SOURCE##*/} )"
336 echo
337 die "Cannot find \$EPATCH_SOURCE!"
338 fi
339
340 local PIPE_CMD
341 case ${EPATCH_SUFFIX##*\.} in
342 xz) PIPE_CMD="xz -dc" ;;
343 lzma) PIPE_CMD="lzma -dc" ;;
344 bz2) PIPE_CMD="bzip2 -dc" ;;
345 gz|Z|z) PIPE_CMD="gzip -dc" ;;
346 ZIP|zip) PIPE_CMD="unzip -p" ;;
347 *) ;;
348 esac
349
350 [[ ${SINGLE_PATCH} == "no" ]] && einfo "${EPATCH_MULTI_MSG}"
351
352 local x
353 for x in "$@" ; do
354 # If the patch dir given contains subdirs, or our EPATCH_SUFFIX
355 # didn't match anything, ignore continue on
356 [[ ! -f ${x} ]] && continue
357
358 local patchname=${x##*/}
359
360 # Apply single patches, or forced sets of patches, or
361 # patches with ARCH dependant names.
362 # ???_arch_foo.patch
363 # Else, skip this input altogether
364 local a=${patchname#*_} # strip the ???_
365 a=${a%%_*} # strip the _foo.patch
366 if ! [[ ${SINGLE_PATCH} == "yes" || \
367 ${EPATCH_FORCE} == "yes" || \
368 ${a} == all || \
369 ${a} == ${ARCH} ]]
163 then 370 then
164 local EPATCH_SOURCE="$1/*" 371 continue
372 fi
373
374 # Let people filter things dynamically
375 if [[ -n ${EPATCH_EXCLUDE} ]] ; then
376 # let people use globs in the exclude
377 eshopts_push -o noglob
378
379 local ex
380 for ex in ${EPATCH_EXCLUDE} ; do
381 if [[ ${patchname} == ${ex} ]] ; then
382 eshopts_pop
383 continue 2
384 fi
385 done
386
387 eshopts_pop
388 fi
389
390 if [[ ${SINGLE_PATCH} == "yes" ]] ; then
391 if [[ -n ${EPATCH_SINGLE_MSG} ]] ; then
392 einfo "${EPATCH_SINGLE_MSG}"
393 else
394 einfo "Applying ${patchname} ..."
395 fi
165 else 396 else
166 local EPATCH_SOURCE="$1/*.${EPATCH_SUFFIX}" 397 einfo " ${patchname} ..."
167 fi 398 fi
168 else 399
169 if [[ ! -d ${EPATCH_SOURCE} ]] || [[ -n $1 ]] ; then 400 # most of the time, there will only be one run per unique name,
170 if [ -n "$1" -a "${EPATCH_SOURCE}" = "${WORKDIR}/patch" ] 401 # but if there are more, make sure we get unique log filenames
171 then 402 local STDERR_TARGET="${T}/${patchname}.out"
172 EPATCH_SOURCE="$1" 403 if [[ -e ${STDERR_TARGET} ]] ; then
404 STDERR_TARGET="${T}/${patchname}-$$.out"
405 fi
406
407 printf "***** %s *****\nPWD: %s\n\n" "${patchname}" "${PWD}" > "${STDERR_TARGET}"
408
409 # Decompress the patch if need be
410 local count=0
411 local PATCH_TARGET
412 if [[ -n ${PIPE_CMD} ]] ; then
413 PATCH_TARGET="${T}/$$.patch"
414 echo "PIPE_COMMAND: ${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> "${STDERR_TARGET}"
415
416 if ! (${PIPE_CMD} "${x}" > "${PATCH_TARGET}") >> "${STDERR_TARGET}" 2>&1 ; then
417 echo
418 eerror "Could not extract patch!"
419 #die "Could not extract patch!"
420 count=5
421 break
173 fi 422 fi
423 else
424 PATCH_TARGET=${x}
425 fi
174 426
427 # Check for absolute paths in patches. If sandbox is disabled,
428 # people could (accidently) patch files in the root filesystem.
429 # Or trigger other unpleasantries #237667. So disallow -p0 on
430 # such patches.
431 local abs_paths=$(egrep -n '^[-+]{3} /' "${PATCH_TARGET}" | awk '$2 != "/dev/null" { print }')
432 if [[ -n ${abs_paths} ]] ; then
433 count=1
434 printf "NOTE: skipping -p0 due to absolute paths in patch:\n%s\n" "${abs_paths}" >> "${STDERR_TARGET}"
435 fi
436 # Similar reason, but with relative paths.
437 local rel_paths=$(egrep -n '^[-+]{3} [^ ]*[.][.]/' "${PATCH_TARGET}")
438 if [[ -n ${rel_paths} ]] ; then
439 eqawarn "QA Notice: Your patch uses relative paths '../'."
440 eqawarn " In the future this will cause a failure."
441 eqawarn "${rel_paths}"
442 fi
443
444 # Dynamically detect the correct -p# ... i'm lazy, so shoot me :/
445 local patch_cmd
446 while [[ ${count} -lt 5 ]] ; do
447 patch_cmd="${BASH_ALIASES[patch]:-patch} -p${count} ${EPATCH_OPTS}"
448
449 # Generate some useful debug info ...
450 (
451 _epatch_draw_line "***** ${patchname} *****"
175 echo 452 echo
176 eerror "Cannot find \$EPATCH_SOURCE! Value for \$EPATCH_SOURCE is:" 453 echo "PATCH COMMAND: ${patch_cmd} < '${PATCH_TARGET}'"
454 echo
455 _epatch_draw_line "***** ${patchname} *****"
456 ${patch_cmd} --dry-run -f < "${PATCH_TARGET}" 2>&1
457 ret=$?
458 echo
459 echo "patch program exited with status ${ret}"
460 exit ${ret}
461 ) >> "${STDERR_TARGET}"
462
463 if [ $? -eq 0 ] ; then
464 (
465 _epatch_draw_line "***** ${patchname} *****"
466 echo
467 echo "ACTUALLY APPLYING ${patchname} ..."
468 echo
469 _epatch_draw_line "***** ${patchname} *****"
470 ${patch_cmd} < "${PATCH_TARGET}" 2>&1
471 ret=$?
472 echo
473 echo "patch program exited with status ${ret}"
474 exit ${ret}
475 ) >> "${STDERR_TARGET}"
476
477 if [ $? -ne 0 ] ; then
478 echo
479 eerror "A dry-run of patch command succeeded, but actually"
480 eerror "applying the patch failed!"
481 #die "Real world sux compared to the dreamworld!"
482 count=5
483 fi
484 break
485 fi
486
487 : $(( count++ ))
488 done
489
490 # if we had to decompress the patch, delete the temp one
491 if [[ -n ${PIPE_CMD} ]] ; then
492 rm -f "${PATCH_TARGET}"
493 fi
494
495 if [[ ${count} -ge 5 ]] ; then
496 echo
497 eerror "Failed Patch: ${patchname} !"
498 eerror " ( ${PATCH_TARGET} )"
177 eerror 499 eerror
178 eerror " ${EPATCH_SOURCE}" 500 eerror "Include in your bugreport the contents of:"
179 eerror " ( ${EPATCH_SOURCE##*/} )" 501 eerror
502 eerror " ${STDERR_TARGET}"
180 echo 503 echo
181 die "Cannot find \$EPATCH_SOURCE!"
182 fi
183
184 local EPATCH_SOURCE="${EPATCH_SOURCE}/*.${EPATCH_SUFFIX}"
185 fi
186
187 case ${EPATCH_SUFFIX##*\.} in
188 lzma)
189 PIPE_CMD="lzma -dc"
190 PATCH_SUFFIX="lzma"
191 ;;
192 bz2)
193 PIPE_CMD="bzip2 -dc"
194 PATCH_SUFFIX="bz2"
195 ;;
196 gz|Z|z)
197 PIPE_CMD="gzip -dc"
198 PATCH_SUFFIX="gz"
199 ;;
200 ZIP|zip)
201 PIPE_CMD="unzip -p"
202 PATCH_SUFFIX="zip"
203 ;;
204 *)
205 PIPE_CMD="cat"
206 PATCH_SUFFIX="patch"
207 ;;
208 esac
209
210 if [ "${SINGLE_PATCH}" = "no" ]
211 then
212 einfo "${EPATCH_MULTI_MSG}"
213 fi
214 for x in ${EPATCH_SOURCE}
215 do
216 # New ARCH dependant patch naming scheme ...
217 #
218 # ???_arch_foo.patch
219 #
220 if [ -f ${x} ] && \
221 ([ "${SINGLE_PATCH}" = "yes" -o "${x/_all_}" != "${x}" -o "${x/_${ARCH}_}" != "${x}" ] || \
222 [ "${EPATCH_FORCE}" = "yes" ])
223 then
224 local count=0
225 local popts="${EPATCH_OPTS}"
226 local patchname=${x##*/}
227
228 if [ -n "${EPATCH_EXCLUDE}" ]
229 then
230 if [ "${EPATCH_EXCLUDE/${patchname}}" != "${EPATCH_EXCLUDE}" ]
231 then
232 continue
233 fi
234 fi
235
236 if [ "${SINGLE_PATCH}" = "yes" ]
237 then
238 if [ -n "${EPATCH_SINGLE_MSG}" ]
239 then
240 einfo "${EPATCH_SINGLE_MSG}"
241 else
242 einfo "Applying ${patchname} ..."
243 fi
244 else
245 einfo " ${patchname} ..."
246 fi
247
248 echo "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
249 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
250
251 # Decompress the patch if need be
252 if [[ ${PATCH_SUFFIX} != "patch" ]] ; then
253 echo -n "PIPE_COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
254 echo "${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
255
256 if ! (${PIPE_CMD} ${x} > ${PATCH_TARGET}) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1 ; then
257 echo
258 eerror "Could not extract patch!"
259 #die "Could not extract patch!"
260 count=5
261 break
262 fi
263 else
264 PATCH_TARGET="${x}"
265 fi
266
267 # Allow for prefix to differ ... im lazy, so shoot me :/
268 while [ "${count}" -lt 5 ]
269 do
270 # Generate some useful debug info ...
271 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
272 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
273
274 echo -n "PATCH COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
275 echo "patch -p${count} ${popts} < ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
276
277 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
278 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
279
280 if (cat ${PATCH_TARGET} | patch -p${count} ${popts} --dry-run -f ; _epatch_assert) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1
281 then
282 _epatch_draw_line "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
283 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
284 echo "ACTUALLY APPLYING ${patchname} ..." >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
285 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
286 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
287
288 cat ${PATCH_TARGET} | patch -p${count} ${popts} >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real 2>&1
289 _epatch_assert
290
291 if [ "$?" -ne 0 ]
292 then
293 cat ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
294 echo
295 eerror "A dry-run of patch command succeeded, but actually"
296 eerror "applying the patch failed!"
297 #die "Real world sux compared to the dreamworld!"
298 count=5
299 fi
300
301 rm -f ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
302
303 break
304 fi
305
306 count=$((count + 1))
307 done
308
309 if [ "${PATCH_SUFFIX}" != "patch" ]
310 then
311 rm -f ${PATCH_TARGET}
312 fi
313
314 if [ "${count}" -eq 5 ]
315 then
316 echo
317 eerror "Failed Patch: ${patchname} !"
318 eerror " ( ${PATCH_TARGET} )"
319 eerror
320 eerror "Include in your bugreport the contents of:"
321 eerror
322 eerror " ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}"
323 echo
324 die "Failed Patch: ${patchname}!" 504 die "Failed Patch: ${patchname}!"
325 fi 505 fi
326 506
327 rm -f ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 507 # if everything worked, delete the full debug patch log
508 rm -f "${STDERR_TARGET}"
328 509
510 # then log away the exact stuff for people to review later
511 cat <<-EOF >> "${T}/epatch.log"
512 PATCH: ${x}
513 CMD: ${patch_cmd}
514 PWD: ${PWD}
515
516 EOF
329 eend 0 517 eend 0
330 fi
331 done 518 done
332 if [ "${SINGLE_PATCH}" = "no" ] 519
333 then 520 [[ ${SINGLE_PATCH} == "no" ]] && einfo "Done with patching"
334 einfo "Done with patching" 521 : # everything worked
522}
523
524# @FUNCTION: epatch_user
525# @USAGE:
526# @DESCRIPTION:
527# Applies user-provided patches to the source tree. The patches are
528# taken from /etc/portage/patches/<CATEGORY>/<PF|P|PN>/, where the first
529# of these three directories to exist will be the one to use, ignoring
530# any more general directories which might exist as well.
531#
532# User patches are intended for quick testing of patches without ebuild
533# modifications, as well as for permanent customizations a user might
534# desire. Obviously, there can be no official support for arbitrarily
535# patched ebuilds. So whenever a build log in a bug report mentions that
536# user patches were applied, the user should be asked to reproduce the
537# problem without these.
538#
539# Not all ebuilds do call this function, so placing patches in the
540# stated directory might or might not work, depending on the package and
541# the eclasses it inherits and uses. It is safe to call the function
542# repeatedly, so it is always possible to add a call at the ebuild
543# level. The first call is the time when the patches will be
544# applied.
545#
546# Ideally, this function should be called after gentoo-specific patches
547# have been applied, so that their code can be modified as well, but
548# before calls to e.g. eautoreconf, as the user patches might affect
549# autotool input files as well.
550epatch_user() {
551 [[ $# -ne 0 ]] && die "epatch_user takes no options"
552
553 # Allow multiple calls to this function; ignore all but the first
554 local applied="${T}/epatch_user.log"
555 [[ -e ${applied} ]] && return 2
556
557 # don't clobber any EPATCH vars that the parent might want
558 local EPATCH_SOURCE check base=${PORTAGE_CONFIGROOT%/}/etc/portage/patches
559 for check in ${CATEGORY}/{${P}-${PR},${P},${PN}}; do
560 EPATCH_SOURCE=${base}/${CTARGET}/${check}
561 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${CHOST}/${check}
562 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${check}
563 if [[ -d ${EPATCH_SOURCE} ]] ; then
564 EPATCH_SOURCE=${EPATCH_SOURCE} \
565 EPATCH_SUFFIX="patch" \
566 EPATCH_FORCE="yes" \
567 EPATCH_MULTI_MSG="Applying user patches from ${EPATCH_SOURCE} ..." \
568 epatch
569 echo "${EPATCH_SOURCE}" > "${applied}"
570 return 0
335 fi 571 fi
572 done
573 echo "none" > "${applied}"
574 return 1
336} 575}
337 576
338# @FUNCTION: emktemp 577# @FUNCTION: emktemp
339# @USAGE: [temp dir] 578# @USAGE: [temp dir]
340# @DESCRIPTION: 579# @DESCRIPTION:
368 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX 607 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX
369 fi 608 fi
370 fi 609 fi
371} 610}
372 611
373# @FUNCTION: egetent
374# @USAGE: <database> <key>
375# @MAINTAINER:
376# base-system@gentoo.org (Linux)
377# Joe Jezak <josejx@gmail.com> (OS X)
378# usata@gentoo.org (OS X)
379# Aaron Walker <ka0ttic@gentoo.org> (FreeBSD)
380# @DESCRIPTION:
381# Small wrapper for getent (Linux), nidump (Mac OS X),
382# and pw (FreeBSD) used in enewuser()/enewgroup()
383egetent() {
384 case ${CHOST} in
385 *-darwin*)
386 case "$2" in
387 *[!0-9]*) # Non numeric
388 nidump $1 . | awk -F":" "{ if (\$1 ~ /^$2$/) {print \$0;exit;} }"
389 ;;
390 *) # Numeric
391 nidump $1 . | awk -F":" "{ if (\$3 == $2) {print \$0;exit;} }"
392 ;;
393 esac
394 ;;
395 *-freebsd*|*-dragonfly*)
396 local opts action="user"
397 [[ $1 == "passwd" ]] || action="group"
398
399 # lookup by uid/gid
400 if [[ $2 == [[:digit:]]* ]] ; then
401 [[ ${action} == "user" ]] && opts="-u" || opts="-g"
402 fi
403
404 pw show ${action} ${opts} "$2" -q
405 ;;
406 *-netbsd*|*-openbsd*)
407 grep "$2:\*:" /etc/$1
408 ;;
409 *)
410 type -p nscd >& /dev/null && nscd -i "$1"
411 getent "$1" "$2"
412 ;;
413 esac
414}
415
416# @FUNCTION: enewuser
417# @USAGE: <user> [uid] [shell] [homedir] [groups] [params]
418# @DESCRIPTION:
419# Same as enewgroup, you are not required to understand how to properly add
420# a user to the system. The only required parameter is the username.
421# Default uid is (pass -1 for this) next available, default shell is
422# /bin/false, default homedir is /dev/null, there are no default groups,
423# and default params sets the comment as 'added by portage for ${PN}'.
424enewuser() {
425 case ${EBUILD_PHASE} in
426 unpack|compile|test|install)
427 eerror "'enewuser()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
428 eerror "Package fails at QA and at life. Please file a bug."
429 die "Bad package! enewuser is only for use in pkg_* functions!"
430 esac
431
432 # get the username
433 local euser=$1; shift
434 if [[ -z ${euser} ]] ; then
435 eerror "No username specified !"
436 die "Cannot call enewuser without a username"
437 fi
438
439 # lets see if the username already exists
440 if [[ -n $(egetent passwd "${euser}") ]] ; then
441 return 0
442 fi
443 einfo "Adding user '${euser}' to your system ..."
444
445 # options to pass to useradd
446 local opts=
447
448 # handle uid
449 local euid=$1; shift
450 if [[ -n ${euid} && ${euid} != -1 ]] ; then
451 if [[ ${euid} -gt 0 ]] ; then
452 if [[ -n $(egetent passwd ${euid}) ]] ; then
453 euid="next"
454 fi
455 else
456 eerror "Userid given but is not greater than 0 !"
457 die "${euid} is not a valid UID"
458 fi
459 else
460 euid="next"
461 fi
462 if [[ ${euid} == "next" ]] ; then
463 for ((euid = 101; euid <= 999; euid++)); do
464 [[ -z $(egetent passwd ${euid}) ]] && break
465 done
466 fi
467 opts="${opts} -u ${euid}"
468 einfo " - Userid: ${euid}"
469
470 # handle shell
471 local eshell=$1; shift
472 if [[ ! -z ${eshell} ]] && [[ ${eshell} != "-1" ]] ; then
473 if [[ ! -e ${ROOT}${eshell} ]] ; then
474 eerror "A shell was specified but it does not exist !"
475 die "${eshell} does not exist in ${ROOT}"
476 fi
477 if [[ ${eshell} == */false || ${eshell} == */nologin ]] ; then
478 eerror "Do not specify ${eshell} yourself, use -1"
479 die "Pass '-1' as the shell parameter"
480 fi
481 else
482 for shell in /sbin/nologin /usr/sbin/nologin /bin/false /usr/bin/false /dev/null ; do
483 [[ -x ${ROOT}${shell} ]] && break
484 done
485
486 if [[ ${shell} == "/dev/null" ]] ; then
487 eerror "Unable to identify the shell to use, proceeding with userland default."
488 case ${USERLAND} in
489 GNU) shell="/bin/false" ;;
490 BSD) shell="/sbin/nologin" ;;
491 Darwin) shell="/usr/sbin/nologin" ;;
492 *) die "Unable to identify the default shell for userland ${USERLAND}"
493 esac
494 fi
495
496 eshell=${shell}
497 fi
498 einfo " - Shell: ${eshell}"
499 opts="${opts} -s ${eshell}"
500
501 # handle homedir
502 local ehome=$1; shift
503 if [[ -z ${ehome} ]] || [[ ${ehome} == "-1" ]] ; then
504 ehome="/dev/null"
505 fi
506 einfo " - Home: ${ehome}"
507 opts="${opts} -d ${ehome}"
508
509 # handle groups
510 local egroups=$1; shift
511 if [[ ! -z ${egroups} ]] ; then
512 local oldifs=${IFS}
513 local defgroup="" exgroups=""
514
515 export IFS=","
516 for g in ${egroups} ; do
517 export IFS=${oldifs}
518 if [[ -z $(egetent group "${g}") ]] ; then
519 eerror "You must add group ${g} to the system first"
520 die "${g} is not a valid GID"
521 fi
522 if [[ -z ${defgroup} ]] ; then
523 defgroup=${g}
524 else
525 exgroups="${exgroups},${g}"
526 fi
527 export IFS=","
528 done
529 export IFS=${oldifs}
530
531 opts="${opts} -g ${defgroup}"
532 if [[ ! -z ${exgroups} ]] ; then
533 opts="${opts} -G ${exgroups:1}"
534 fi
535 else
536 egroups="(none)"
537 fi
538 einfo " - Groups: ${egroups}"
539
540 # handle extra and add the user
541 local oldsandbox=${SANDBOX_ON}
542 export SANDBOX_ON="0"
543 case ${CHOST} in
544 *-darwin*)
545 ### Make the user
546 if [[ -z $@ ]] ; then
547 dscl . create /users/${euser} uid ${euid}
548 dscl . create /users/${euser} shell ${eshell}
549 dscl . create /users/${euser} home ${ehome}
550 dscl . create /users/${euser} realname "added by portage for ${PN}"
551 ### Add the user to the groups specified
552 local oldifs=${IFS}
553 export IFS=","
554 for g in ${egroups} ; do
555 dscl . merge /groups/${g} users ${euser}
556 done
557 export IFS=${oldifs}
558 else
559 einfo "Extra options are not supported on Darwin yet"
560 einfo "Please report the ebuild along with the info below"
561 einfo "eextra: $@"
562 die "Required function missing"
563 fi
564 ;;
565 *-freebsd*|*-dragonfly*)
566 if [[ -z $@ ]] ; then
567 pw useradd ${euser} ${opts} \
568 -c "added by portage for ${PN}" \
569 die "enewuser failed"
570 else
571 einfo " - Extra: $@"
572 pw useradd ${euser} ${opts} \
573 "$@" || die "enewuser failed"
574 fi
575 ;;
576
577 *-netbsd*)
578 if [[ -z $@ ]] ; then
579 useradd ${opts} ${euser} || die "enewuser failed"
580 else
581 einfo " - Extra: $@"
582 useradd ${opts} ${euser} "$@" || die "enewuser failed"
583 fi
584 ;;
585
586 *-openbsd*)
587 if [[ -z $@ ]] ; then
588 useradd -u ${euid} -s ${eshell} \
589 -d ${ehome} -c "Added by portage for ${PN}" \
590 -g ${egroups} ${euser} || die "enewuser failed"
591 else
592 einfo " - Extra: $@"
593 useradd -u ${euid} -s ${eshell} \
594 -d ${ehome} -c "Added by portage for ${PN}" \
595 -g ${egroups} ${euser} "$@" || die "enewuser failed"
596 fi
597 ;;
598
599 *)
600 if [[ -z $@ ]] ; then
601 useradd ${opts} ${euser} \
602 -c "added by portage for ${PN}" \
603 || die "enewuser failed"
604 else
605 einfo " - Extra: $@"
606 useradd ${opts} ${euser} "$@" \
607 || die "enewuser failed"
608 fi
609 ;;
610 esac
611
612 if [[ ! -e ${ROOT}/${ehome} ]] ; then
613 einfo " - Creating ${ehome} in ${ROOT}"
614 mkdir -p "${ROOT}/${ehome}"
615 chown ${euser} "${ROOT}/${ehome}"
616 chmod 755 "${ROOT}/${ehome}"
617 fi
618
619 export SANDBOX_ON=${oldsandbox}
620}
621
622# @FUNCTION: enewgroup
623# @USAGE: <group> [gid]
624# @DESCRIPTION:
625# This function does not require you to understand how to properly add a
626# group to the system. Just give it a group name to add and enewgroup will
627# do the rest. You may specify the gid for the group or allow the group to
628# allocate the next available one.
629enewgroup() {
630 case ${EBUILD_PHASE} in
631 unpack|compile|test|install)
632 eerror "'enewgroup()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
633 eerror "Package fails at QA and at life. Please file a bug."
634 die "Bad package! enewgroup is only for use in pkg_* functions!"
635 esac
636
637 # get the group
638 local egroup="$1"; shift
639 if [ -z "${egroup}" ]
640 then
641 eerror "No group specified !"
642 die "Cannot call enewgroup without a group"
643 fi
644
645 # see if group already exists
646 if [[ -n $(egetent group "${egroup}") ]]; then
647 return 0
648 fi
649 einfo "Adding group '${egroup}' to your system ..."
650
651 # options to pass to useradd
652 local opts=
653
654 # handle gid
655 local egid="$1"; shift
656 if [ ! -z "${egid}" ]
657 then
658 if [ "${egid}" -gt 0 ]
659 then
660 if [ -z "`egetent group ${egid}`" ]
661 then
662 if [[ "${CHOST}" == *-darwin* ]]; then
663 opts="${opts} ${egid}"
664 else
665 opts="${opts} -g ${egid}"
666 fi
667 else
668 egid="next available; requested gid taken"
669 fi
670 else
671 eerror "Groupid given but is not greater than 0 !"
672 die "${egid} is not a valid GID"
673 fi
674 else
675 egid="next available"
676 fi
677 einfo " - Groupid: ${egid}"
678
679 # handle extra
680 local eextra="$@"
681 opts="${opts} ${eextra}"
682
683 # add the group
684 local oldsandbox="${SANDBOX_ON}"
685 export SANDBOX_ON="0"
686 case ${CHOST} in
687 *-darwin*)
688 if [ ! -z "${eextra}" ];
689 then
690 einfo "Extra options are not supported on Darwin/OS X yet"
691 einfo "Please report the ebuild along with the info below"
692 einfo "eextra: ${eextra}"
693 die "Required function missing"
694 fi
695
696 # If we need the next available
697 case ${egid} in
698 *[!0-9]*) # Non numeric
699 for ((egid = 101; egid <= 999; egid++)); do
700 [[ -z $(egetent group ${egid}) ]] && break
701 done
702 esac
703 dscl . create /groups/${egroup} gid ${egid}
704 dscl . create /groups/${egroup} passwd '*'
705 ;;
706
707 *-freebsd*|*-dragonfly*)
708 case ${egid} in
709 *[!0-9]*) # Non numeric
710 for ((egid = 101; egid <= 999; egid++)); do
711 [[ -z $(egetent group ${egid}) ]] && break
712 done
713 esac
714 pw groupadd ${egroup} -g ${egid} || die "enewgroup failed"
715 ;;
716
717 *-netbsd*)
718 case ${egid} in
719 *[!0-9]*) # Non numeric
720 for ((egid = 101; egid <= 999; egid++)); do
721 [[ -z $(egetent group ${egid}) ]] && break
722 done
723 esac
724 groupadd -g ${egid} ${egroup} || die "enewgroup failed"
725 ;;
726
727 *)
728 groupadd ${opts} ${egroup} || die "enewgroup failed"
729 ;;
730 esac
731 export SANDBOX_ON="${oldsandbox}"
732}
733
734# @FUNCTION: edos2unix 612# @FUNCTION: edos2unix
735# @USAGE: <file> [more files ...] 613# @USAGE: <file> [more files ...]
736# @DESCRIPTION: 614# @DESCRIPTION:
737# A handy replacement for dos2unix, recode, fixdos, etc... This allows you 615# A handy replacement for dos2unix, recode, fixdos, etc... This allows you
738# to remove all of these text utilities from DEPEND variables because this 616# to remove all of these text utilities from DEPEND variables because this
739# is a script based solution. Just give it a list of files to convert and 617# is a script based solution. Just give it a list of files to convert and
740# they will all be changed from the DOS CRLF format to the UNIX LF format. 618# they will all be changed from the DOS CRLF format to the UNIX LF format.
741edos2unix() { 619edos2unix() {
742 echo "$@" | xargs sed -i 's/\r$//' 620 [[ $# -eq 0 ]] && return 0
621 sed -i 's/\r$//' -- "$@" || die
743} 622}
744 623
624# @FUNCTION: make_desktop_entry
625# @USAGE: make_desktop_entry(<command>, [name], [icon], [type], [fields])
626# @DESCRIPTION:
745# Make a desktop file ! 627# Make a .desktop file.
746# Great for making those icons in kde/gnome startmenu !
747# Amaze your friends ! Get the women ! Join today !
748# 628#
749# make_desktop_entry(<command>, [name], [icon], [type], [path]) 629# @CODE
750#
751# binary: what command does the app run with ? 630# binary: what command does the app run with ?
752# name: the name that will show up in the menu 631# name: the name that will show up in the menu
753# icon: give your little like a pretty little icon ... 632# icon: give your little like a pretty little icon ...
754# this can be relative (to /usr/share/pixmaps) or 633# this can be relative (to /usr/share/pixmaps) or
755# a full path to an icon 634# a full path to an icon
756# type: what kind of application is this ? for categories: 635# type: what kind of application is this?
636# for categories:
757# http://standards.freedesktop.org/menu-spec/latest/apa.html 637# http://standards.freedesktop.org/menu-spec/latest/apa.html
758# path: if your app needs to startup in a specific dir 638# if unset, function tries to guess from package's category
639# fields: extra fields to append to the desktop file; a printf string
640# @CODE
759make_desktop_entry() { 641make_desktop_entry() {
760 [[ -z $1 ]] && eerror "make_desktop_entry: You must specify the executable" && return 1 642 [[ -z $1 ]] && die "make_desktop_entry: You must specify the executable"
761 643
762 local exec=${1} 644 local exec=${1}
763 local name=${2:-${PN}} 645 local name=${2:-${PN}}
764 local icon=${3:-${PN}} 646 local icon=${3:-${PN}}
765 local type=${4} 647 local type=${4}
766 local path=${5} 648 local fields=${5}
767 649
768 if [[ -z ${type} ]] ; then 650 if [[ -z ${type} ]] ; then
769 local catmaj=${CATEGORY%%-*} 651 local catmaj=${CATEGORY%%-*}
770 local catmin=${CATEGORY##*-} 652 local catmin=${CATEGORY##*-}
771 case ${catmaj} in 653 case ${catmaj} in
772 app) 654 app)
773 case ${catmin} in 655 case ${catmin} in
774 accessibility) type=Accessibility;; 656 accessibility) type="Utility;Accessibility";;
775 admin) type=System;; 657 admin) type=System;;
776 antivirus) type=System;; 658 antivirus) type=System;;
777 arch) type=Archiving;; 659 arch) type="Utility;Archiving";;
778 backup) type=Archiving;; 660 backup) type="Utility;Archiving";;
779 cdr) type=DiscBurning;; 661 cdr) type="AudioVideo;DiscBurning";;
780 dicts) type=Dictionary;; 662 dicts) type="Office;Dictionary";;
781 doc) type=Documentation;; 663 doc) type=Documentation;;
782 editors) type=TextEditor;; 664 editors) type="Utility;TextEditor";;
783 emacs) type=TextEditor;; 665 emacs) type="Development;TextEditor";;
784 emulation) type=Emulator;; 666 emulation) type="System;Emulator";;
785 laptop) type=HardwareSettings;; 667 laptop) type="Settings;HardwareSettings";;
786 office) type=Office;; 668 office) type=Office;;
787 pda) type=PDA;; 669 pda) type="Office;PDA";;
788 vim) type=TextEditor;; 670 vim) type="Development;TextEditor";;
789 xemacs) type=TextEditor;; 671 xemacs) type="Development;TextEditor";;
790 *) type=;;
791 esac 672 esac
792 ;; 673 ;;
793 674
794 dev) 675 dev)
795 type="Development" 676 type="Development"
796 ;; 677 ;;
797 678
798 games) 679 games)
799 case ${catmin} in 680 case ${catmin} in
800 action|fps) type=ActionGame;; 681 action|fps) type=ActionGame;;
801 arcade) type=ArcadeGame;; 682 arcade) type=ArcadeGame;;
802 board) type=BoardGame;; 683 board) type=BoardGame;;
803 emulation) type=Emulator;; 684 emulation) type=Emulator;;
804 kids) type=KidsGame;; 685 kids) type=KidsGame;;
805 puzzle) type=LogicGame;; 686 puzzle) type=LogicGame;;
806 roguelike) type=RolePlaying;; 687 roguelike) type=RolePlaying;;
807 rpg) type=RolePlaying;; 688 rpg) type=RolePlaying;;
808 simulation) type=Simulation;; 689 simulation) type=Simulation;;
809 sports) type=SportsGame;; 690 sports) type=SportsGame;;
810 strategy) type=StrategyGame;; 691 strategy) type=StrategyGame;;
811 *) type=;;
812 esac 692 esac
813 type="Game;${type}" 693 type="Game;${type}"
814 ;; 694 ;;
815 695
816 gnome) 696 gnome)
825 type="Network;Email" 705 type="Network;Email"
826 ;; 706 ;;
827 707
828 media) 708 media)
829 case ${catmin} in 709 case ${catmin} in
710 gfx)
830 gfx) type=Graphics;; 711 type=Graphics
712 ;;
713 *)
714 case ${catmin} in
831 radio) type=Tuner;; 715 radio) type=Tuner;;
832 sound) type=Audio;; 716 sound) type=Audio;;
833 tv) type=TV;; 717 tv) type=TV;;
834 video) type=Video;; 718 video) type=Video;;
835 *) type=;; 719 esac
720 type="AudioVideo;${type}"
721 ;;
836 esac 722 esac
837 type="AudioVideo;${type}"
838 ;; 723 ;;
839 724
840 net) 725 net)
841 case ${catmin} in 726 case ${catmin} in
842 dialup) type=Dialup;; 727 dialup) type=Dialup;;
843 ftp) type=FileTransfer;; 728 ftp) type=FileTransfer;;
844 im) type=InstantMessaging;; 729 im) type=InstantMessaging;;
845 irc) type=IRCClient;; 730 irc) type=IRCClient;;
846 mail) type=Email;; 731 mail) type=Email;;
847 news) type=News;; 732 news) type=News;;
848 nntp) type=News;; 733 nntp) type=News;;
849 p2p) type=FileTransfer;; 734 p2p) type=FileTransfer;;
850 *) type=;; 735 voip) type=Telephony;;
851 esac 736 esac
852 type="Network;${type}" 737 type="Network;${type}"
853 ;; 738 ;;
854 739
855 sci) 740 sci)
856 case ${catmin} in 741 case ${catmin} in
857 astro*) type=Astronomy;; 742 astro*) type=Astronomy;;
858 bio*) type=Biology;; 743 bio*) type=Biology;;
859 calc*) type=Calculator;; 744 calc*) type=Calculator;;
860 chem*) type=Chemistry;; 745 chem*) type=Chemistry;;
861 elec*) type=Electronics;; 746 elec*) type=Electronics;;
862 geo*) type=Geology;; 747 geo*) type=Geology;;
863 math*) type=Math;; 748 math*) type=Math;;
864 physics) type=Physics;; 749 physics) type=Physics;;
865 visual*) type=DataVisualization;; 750 visual*) type=DataVisualization;;
866 *) type=;;
867 esac 751 esac
868 type="Science;${type}" 752 type="Education;Science;${type}"
869 ;; 753 ;;
870 754
871 sys) 755 sys)
872 type="System" 756 type="System"
873 ;; 757 ;;
874 758
875 www) 759 www)
876 case ${catmin} in 760 case ${catmin} in
877 client) type=WebBrowser;; 761 client) type=WebBrowser;;
878 *) type=;;
879 esac 762 esac
880 type="Network" 763 type="Network;${type}"
881 ;; 764 ;;
882 765
883 *) 766 *)
884 type= 767 type=
885 ;; 768 ;;
891 local desktop_name="${PN}-${SLOT}" 774 local desktop_name="${PN}-${SLOT}"
892 fi 775 fi
893 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop" 776 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop"
894 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop 777 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop
895 778
779 # Don't append another ";" when a valid category value is provided.
780 type=${type%;}${type:+;}
781
782 eshopts_push -s extglob
783 if [[ -n ${icon} && ${icon} != /* ]] && [[ ${icon} == *.xpm || ${icon} == *.png || ${icon} == *.svg ]]; then
784 ewarn "As described in the Icon Theme Specification, icon file extensions are not"
785 ewarn "allowed in .desktop files if the value is not an absolute path."
786 icon=${icon%.@(xpm|png|svg)}
787 fi
788 eshopts_pop
789
896 cat <<-EOF > "${desktop}" 790 cat <<-EOF > "${desktop}"
897 [Desktop Entry] 791 [Desktop Entry]
898 Version=1.0
899 Name=${name} 792 Name=${name}
900 Type=Application 793 Type=Application
901 Comment=${DESCRIPTION} 794 Comment=${DESCRIPTION}
902 Exec=${exec} 795 Exec=${exec}
903 TryExec=${exec%% *} 796 TryExec=${exec%% *}
904 Icon=${icon} 797 Icon=${icon}
905 Categories=${type}; 798 Categories=${type}
906 EOF 799 EOF
907 800
908 [[ ${path} ]] && echo "Path=${path}" >> "${desktop}" 801 if [[ ${fields:-=} != *=* ]] ; then
802 # 5th arg used to be value to Path=
803 ewarn "make_desktop_entry: update your 5th arg to read Path=${fields}"
804 fields="Path=${fields}"
805 fi
806 [[ -n ${fields} ]] && printf '%b\n' "${fields}" >> "${desktop}"
909 807
910 ( 808 (
911 # wrap the env here so that the 'insinto' call 809 # wrap the env here so that the 'insinto' call
912 # doesn't corrupt the env of the caller 810 # doesn't corrupt the env of the caller
913 insinto /usr/share/applications 811 insinto /usr/share/applications
914 doins "${desktop}" 812 doins "${desktop}"
915 ) 813 ) || die "installing desktop file failed"
916} 814}
917 815
918# @FUNCTION: validate_desktop_entries 816# @FUNCTION: validate_desktop_entries
919# @USAGE: [directories] 817# @USAGE: [directories]
920# @MAINTAINER: 818# @MAINTAINER:
942 einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo." 840 einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo."
943 fi 841 fi
944} 842}
945 843
946# @FUNCTION: make_session_desktop 844# @FUNCTION: make_session_desktop
947# @USAGE: <title> <command> 845# @USAGE: <title> <command> [command args...]
948# @DESCRIPTION: 846# @DESCRIPTION:
949# Make a GDM/KDM Session file. The title is the file to execute to start the 847# Make a GDM/KDM Session file. The title is the file to execute to start the
950# Window Manager. The command is the name of the Window Manager. 848# Window Manager. The command is the name of the Window Manager.
849#
850# You can set the name of the file via the ${wm} variable.
951make_session_desktop() { 851make_session_desktop() {
952 [[ -z $1 ]] && eerror "make_session_desktop: You must specify the title" && return 1 852 [[ -z $1 ]] && eerror "$0: You must specify the title" && return 1
953 [[ -z $2 ]] && eerror "make_session_desktop: You must specify the command" && return 1 853 [[ -z $2 ]] && eerror "$0: You must specify the command" && return 1
954 854
955 local title=$1 855 local title=$1
956 local command=$2 856 local command=$2
957 local desktop=${T}/${wm}.desktop 857 local desktop=${T}/${wm:-${PN}}.desktop
858 shift 2
958 859
959 cat <<-EOF > "${desktop}" 860 cat <<-EOF > "${desktop}"
960 [Desktop Entry] 861 [Desktop Entry]
961 Name=${title} 862 Name=${title}
962 Comment=This session logs you into ${title} 863 Comment=This session logs you into ${title}
963 Exec=${command} 864 Exec=${command} $*
964 TryExec=${command} 865 TryExec=${command}
965 Type=Application 866 Type=XSession
966 EOF 867 EOF
967 868
968 ( 869 (
969 # wrap the env here so that the 'insinto' call 870 # wrap the env here so that the 'insinto' call
970 # doesn't corrupt the env of the caller 871 # doesn't corrupt the env of the caller
1053 insinto /usr/share/pixmaps 954 insinto /usr/share/pixmaps
1054 newins "$@" 955 newins "$@"
1055 ) 956 )
1056} 957}
1057 958
1058# for internal use only (unpack_pdv and unpack_makeself)
1059find_unpackable_file() {
1060 local src=$1
1061 if [[ -z ${src} ]] ; then
1062 src=${DISTDIR}/${A}
1063 else
1064 if [[ -e ${DISTDIR}/${src} ]] ; then
1065 src=${DISTDIR}/${src}
1066 elif [[ -e ${PWD}/${src} ]] ; then
1067 src=${PWD}/${src}
1068 elif [[ -e ${src} ]] ; then
1069 src=${src}
1070 fi
1071 fi
1072 [[ ! -e ${src} ]] && return 1
1073 echo "${src}"
1074}
1075
1076# @FUNCTION: unpack_pdv
1077# @USAGE: <file to unpack> <size of off_t>
1078# @DESCRIPTION:
1079# Unpack those pesky pdv generated files ...
1080# They're self-unpacking programs with the binary package stuffed in
1081# the middle of the archive. Valve seems to use it a lot ... too bad
1082# it seems to like to segfault a lot :(. So lets take it apart ourselves.
1083#
1084# You have to specify the off_t size ... I have no idea how to extract that
1085# information out of the binary executable myself. Basically you pass in
1086# the size of the off_t type (in bytes) on the machine that built the pdv
1087# archive.
1088#
1089# One way to determine this is by running the following commands:
1090#
1091# @CODE
1092# strings <pdv archive> | grep lseek
1093# strace -elseek <pdv archive>
1094# @CODE
1095#
1096# Basically look for the first lseek command (we do the strings/grep because
1097# sometimes the function call is _llseek or something) and steal the 2nd
1098# parameter. Here is an example:
1099#
1100# @CODE
1101# vapier@vapier 0 pdv_unpack # strings hldsupdatetool.bin | grep lseek
1102# lseek
1103# vapier@vapier 0 pdv_unpack # strace -elseek ./hldsupdatetool.bin
1104# lseek(3, -4, SEEK_END) = 2981250
1105# @CODE
1106#
1107# Thus we would pass in the value of '4' as the second parameter.
1108unpack_pdv() {
1109 local src=$(find_unpackable_file "$1")
1110 local sizeoff_t=$2
1111
1112 [[ -z ${src} ]] && die "Could not locate source for '$1'"
1113 [[ -z ${sizeoff_t} ]] && die "No idea what off_t size was used for this pdv :("
1114
1115 local shrtsrc=$(basename "${src}")
1116 echo ">>> Unpacking ${shrtsrc} to ${PWD}"
1117 local metaskip=$(tail -c ${sizeoff_t} "${src}" | hexdump -e \"%i\")
1118 local tailskip=$(tail -c $((${sizeoff_t}*2)) "${src}" | head -c ${sizeoff_t} | hexdump -e \"%i\")
1119
1120 # grab metadata for debug reasons
1121 local metafile=$(emktemp)
1122 tail -c +$((${metaskip}+1)) "${src}" > "${metafile}"
1123
1124 # rip out the final file name from the metadata
1125 local datafile=$(tail -c +$((${metaskip}+1)) "${src}" | strings | head -n 1)
1126 datafile=$(basename "${datafile}")
1127
1128 # now lets uncompress/untar the file if need be
1129 local tmpfile=$(emktemp)
1130 tail -c +$((${tailskip}+1)) ${src} 2>/dev/null | head -c 512 > ${tmpfile}
1131
1132 local iscompressed=$(file -b "${tmpfile}")
1133 if [[ ${iscompressed:0:8} == "compress" ]] ; then
1134 iscompressed=1
1135 mv ${tmpfile}{,.Z}
1136 gunzip ${tmpfile}
1137 else
1138 iscompressed=0
1139 fi
1140 local istar=$(file -b "${tmpfile}")
1141 if [[ ${istar:0:9} == "POSIX tar" ]] ; then
1142 istar=1
1143 else
1144 istar=0
1145 fi
1146
1147 #for some reason gzip dies with this ... dd cant provide buffer fast enough ?
1148 #dd if=${src} ibs=${metaskip} count=1 \
1149 # | dd ibs=${tailskip} skip=1 \
1150 # | gzip -dc \
1151 # > ${datafile}
1152 if [ ${iscompressed} -eq 1 ] ; then
1153 if [ ${istar} -eq 1 ] ; then
1154 tail -c +$((${tailskip}+1)) ${src} 2>/dev/null \
1155 | head -c $((${metaskip}-${tailskip})) \
1156 | tar -xzf -
1157 else
1158 tail -c +$((${tailskip}+1)) ${src} 2>/dev/null \
1159 | head -c $((${metaskip}-${tailskip})) \
1160 | gzip -dc \
1161 > ${datafile}
1162 fi
1163 else
1164 if [ ${istar} -eq 1 ] ; then
1165 tail -c +$((${tailskip}+1)) ${src} 2>/dev/null \
1166 | head -c $((${metaskip}-${tailskip})) \
1167 | tar --no-same-owner -xf -
1168 else
1169 tail -c +$((${tailskip}+1)) ${src} 2>/dev/null \
1170 | head -c $((${metaskip}-${tailskip})) \
1171 > ${datafile}
1172 fi
1173 fi
1174 true
1175 #[ -s "${datafile}" ] || die "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
1176 #assert "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
1177}
1178
1179# @FUNCTION: unpack_makeself
1180# @USAGE: [file to unpack] [offset] [tail|dd]
1181# @DESCRIPTION:
1182# Unpack those pesky makeself generated files ...
1183# They're shell scripts with the binary package tagged onto
1184# the end of the archive. Loki utilized the format as does
1185# many other game companies.
1186#
1187# If the file is not specified, then ${A} is used. If the
1188# offset is not specified then we will attempt to extract
1189# the proper offset from the script itself.
1190unpack_makeself() {
1191 local src_input=${1:-${A}}
1192 local src=$(find_unpackable_file "${src_input}")
1193 local skip=$2
1194 local exe=$3
1195
1196 [[ -z ${src} ]] && die "Could not locate source for '${src_input}'"
1197
1198 local shrtsrc=$(basename "${src}")
1199 echo ">>> Unpacking ${shrtsrc} to ${PWD}"
1200 if [[ -z ${skip} ]] ; then
1201 local ver=$(grep -a '#.*Makeself' "${src}" | awk '{print $NF}')
1202 local skip=0
1203 exe=tail
1204 case ${ver} in
1205 1.5.*|1.6.0-nv) # tested 1.5.{3,4,5} ... guessing 1.5.x series is same
1206 skip=$(grep -a ^skip= "${src}" | cut -d= -f2)
1207 ;;
1208 2.0|2.0.1)
1209 skip=$(grep -a ^$'\t'tail "${src}" | awk '{print $2}' | cut -b2-)
1210 ;;
1211 2.1.1)
1212 skip=$(grep -a ^offset= "${src}" | awk '{print $2}' | cut -b2-)
1213 let skip="skip + 1"
1214 ;;
1215 2.1.2)
1216 skip=$(grep -a ^offset= "${src}" | awk '{print $3}' | head -n 1)
1217 let skip="skip + 1"
1218 ;;
1219 2.1.3)
1220 skip=`grep -a ^offset= "${src}" | awk '{print $3}'`
1221 let skip="skip + 1"
1222 ;;
1223 2.1.4|2.1.5)
1224 skip=$(grep -a offset=.*head.*wc "${src}" | awk '{print $3}' | head -n 1)
1225 skip=$(head -n ${skip} "${src}" | wc -c)
1226 exe="dd"
1227 ;;
1228 *)
1229 eerror "I'm sorry, but I was unable to support the Makeself file."
1230 eerror "The version I detected was '${ver}'."
1231 eerror "Please file a bug about the file ${shrtsrc} at"
1232 eerror "http://bugs.gentoo.org/ so that support can be added."
1233 die "makeself version '${ver}' not supported"
1234 ;;
1235 esac
1236 debug-print "Detected Makeself version ${ver} ... using ${skip} as offset"
1237 fi
1238 case ${exe} in
1239 tail) exe="tail -n +${skip} '${src}'";;
1240 dd) exe="dd ibs=${skip} skip=1 obs=1024 conv=sync if='${src}'";;
1241 *) die "makeself cant handle exe '${exe}'"
1242 esac
1243
1244 # lets grab the first few bytes of the file to figure out what kind of archive it is
1245 local tmpfile=$(emktemp)
1246 eval ${exe} 2>/dev/null | head -c 512 > "${tmpfile}"
1247 local filetype=$(file -b "${tmpfile}")
1248 case ${filetype} in
1249 *tar\ archive*)
1250 eval ${exe} | tar --no-same-owner -xf -
1251 ;;
1252 bzip2*)
1253 eval ${exe} | bzip2 -dc | tar --no-same-owner -xf -
1254 ;;
1255 gzip*)
1256 eval ${exe} | tar --no-same-owner -xzf -
1257 ;;
1258 compress*)
1259 eval ${exe} | gunzip | tar --no-same-owner -xf -
1260 ;;
1261 *)
1262 eerror "Unknown filetype \"${filetype}\" ?"
1263 false
1264 ;;
1265 esac
1266 assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})"
1267}
1268
1269# @FUNCTION: check_license
1270# @USAGE: [license]
1271# @DESCRIPTION:
1272# Display a license for user to accept. If no license is
1273# specified, then ${LICENSE} is used.
1274check_license() {
1275 local lic=$1
1276 if [ -z "${lic}" ] ; then
1277 lic="${PORTDIR}/licenses/${LICENSE}"
1278 else
1279 if [ -e "${PORTDIR}/licenses/${lic}" ] ; then
1280 lic="${PORTDIR}/licenses/${lic}"
1281 elif [ -e "${PWD}/${lic}" ] ; then
1282 lic="${PWD}/${lic}"
1283 elif [ -e "${lic}" ] ; then
1284 lic="${lic}"
1285 fi
1286 fi
1287 [ ! -f "${lic}" ] && die "Could not find requested license ${lic}"
1288 local l="`basename ${lic}`"
1289
1290 # here is where we check for the licenses the user already
1291 # accepted ... if we don't find a match, we make the user accept
1292 local shopts=$-
1293 local alic
1294 set -o noglob #so that bash doesn't expand "*"
1295 for alic in ${ACCEPT_LICENSE} ; do
1296 if [[ ${alic} == ${l} ]]; then
1297 set +o noglob; set -${shopts} #reset old shell opts
1298 return 0
1299 fi
1300 done
1301 set +o noglob; set -$shopts #reset old shell opts
1302
1303 local licmsg=$(emktemp)
1304 cat <<-EOF > ${licmsg}
1305 **********************************************************
1306 The following license outlines the terms of use of this
1307 package. You MUST accept this license for installation to
1308 continue. When you are done viewing, hit 'q'. If you
1309 CTRL+C out of this, the install will not run!
1310 **********************************************************
1311
1312 EOF
1313 cat ${lic} >> ${licmsg}
1314 ${PAGER:-less} ${licmsg} || die "Could not execute pager (${PAGER}) to accept ${lic}"
1315 einfon "Do you accept the terms of this license (${l})? [yes/no] "
1316 read alic
1317 case ${alic} in
1318 yes|Yes|y|Y)
1319 return 0
1320 ;;
1321 *)
1322 echo;echo;echo
1323 eerror "You MUST accept the license to continue! Exiting!"
1324 die "Failed to accept license"
1325 ;;
1326 esac
1327}
1328
1329# @FUNCTION: cdrom_get_cds
1330# @USAGE: <file on cd1> [file on cd2] [file on cd3] [...]
1331# @DESCRIPTION:
1332# Aquire cd(s) for those lovely cd-based emerges. Yes, this violates
1333# the whole 'non-interactive' policy, but damnit I want CD support !
1334#
1335# With these cdrom functions we handle all the user interaction and
1336# standardize everything. All you have to do is call cdrom_get_cds()
1337# and when the function returns, you can assume that the cd has been
1338# found at CDROM_ROOT.
1339#
1340# The function will attempt to locate a cd based upon a file that is on
1341# the cd. The more files you give this function, the more cds
1342# the cdrom functions will handle.
1343#
1344# Normally the cdrom functions will refer to the cds as 'cd #1', 'cd #2',
1345# etc... If you want to give the cds better names, then just export
1346# the appropriate CDROM_NAME variable before calling cdrom_get_cds().
1347# Use CDROM_NAME for one cd, or CDROM_NAME_# for multiple cds. You can
1348# also use the CDROM_NAME_SET bash array.
1349#
1350# For those multi cd ebuilds, see the cdrom_load_next_cd() function.
1351cdrom_get_cds() {
1352 # first we figure out how many cds we're dealing with by
1353 # the # of files they gave us
1354 local cdcnt=0
1355 local f=
1356 for f in "$@" ; do
1357 ((++cdcnt))
1358 export CDROM_CHECK_${cdcnt}="$f"
1359 done
1360 export CDROM_TOTAL_CDS=${cdcnt}
1361 export CDROM_CURRENT_CD=1
1362
1363 # now we see if the user gave use CD_ROOT ...
1364 # if they did, let's just believe them that it's correct
1365 if [[ -n ${CD_ROOT}${CD_ROOT_1} ]] ; then
1366 local var=
1367 cdcnt=0
1368 while [[ ${cdcnt} -lt ${CDROM_TOTAL_CDS} ]] ; do
1369 ((++cdcnt))
1370 var="CD_ROOT_${cdcnt}"
1371 [[ -z ${!var} ]] && var="CD_ROOT"
1372 if [[ -z ${!var} ]] ; then
1373 eerror "You must either use just the CD_ROOT"
1374 eerror "or specify ALL the CD_ROOT_X variables."
1375 eerror "In this case, you will need ${CDROM_TOTAL_CDS} CD_ROOT_X variables."
1376 die "could not locate CD_ROOT_${cdcnt}"
1377 fi
1378 done
1379 export CDROM_ROOT=${CD_ROOT_1:-${CD_ROOT}}
1380 einfo "Found CD #${CDROM_CURRENT_CD} root at ${CDROM_ROOT}"
1381 export CDROM_SET=-1
1382 for f in ${CDROM_CHECK_1//:/ } ; do
1383 ((++CDROM_SET))
1384 [[ -e ${CD_ROOT}/${f} ]] && break
1385 done
1386 export CDROM_MATCH=${f}
1387 return
1388 fi
1389
1390 # User didn't help us out so lets make sure they know they can
1391 # simplify the whole process ...
1392 if [[ ${CDROM_TOTAL_CDS} -eq 1 ]] ; then
1393 einfo "This ebuild will need the ${CDROM_NAME:-cdrom for ${PN}}"
1394 echo
1395 einfo "If you do not have the CD, but have the data files"
1396 einfo "mounted somewhere on your filesystem, just export"
1397 einfo "the variable CD_ROOT so that it points to the"
1398 einfo "directory containing the files."
1399 echo
1400 einfo "For example:"
1401 einfo "export CD_ROOT=/mnt/cdrom"
1402 echo
1403 else
1404 if [[ -n ${CDROM_NAME_SET} ]] ; then
1405 # Translate the CDROM_NAME_SET array into CDROM_NAME_#
1406 cdcnt=0
1407 while [[ ${cdcnt} -lt ${CDROM_TOTAL_CDS} ]] ; do
1408 ((++cdcnt))
1409 export CDROM_NAME_${cdcnt}="${CDROM_NAME_SET[$((${cdcnt}-1))]}"
1410 done
1411 fi
1412
1413 einfo "This package will need access to ${CDROM_TOTAL_CDS} cds."
1414 cdcnt=0
1415 while [[ ${cdcnt} -lt ${CDROM_TOTAL_CDS} ]] ; do
1416 ((++cdcnt))
1417 var="CDROM_NAME_${cdcnt}"
1418 [[ ! -z ${!var} ]] && einfo " CD ${cdcnt}: ${!var}"
1419 done
1420 echo
1421 einfo "If you do not have the CDs, but have the data files"
1422 einfo "mounted somewhere on your filesystem, just export"
1423 einfo "the following variables so they point to the right place:"
1424 einfon ""
1425 cdcnt=0
1426 while [[ ${cdcnt} -lt ${CDROM_TOTAL_CDS} ]] ; do
1427 ((++cdcnt))
1428 echo -n " CD_ROOT_${cdcnt}"
1429 done
1430 echo
1431 einfo "Or, if you have all the files in the same place, or"
1432 einfo "you only have one cdrom, you can export CD_ROOT"
1433 einfo "and that place will be used as the same data source"
1434 einfo "for all the CDs."
1435 echo
1436 einfo "For example:"
1437 einfo "export CD_ROOT_1=/mnt/cdrom"
1438 echo
1439 fi
1440
1441 export CDROM_SET=""
1442 export CDROM_CURRENT_CD=0
1443 cdrom_load_next_cd
1444}
1445
1446# @FUNCTION: cdrom_load_next_cd
1447# @DESCRIPTION:
1448# Some packages are so big they come on multiple CDs. When you're done reading
1449# files off a CD and want access to the next one, just call this function.
1450# Again, all the messy details of user interaction are taken care of for you.
1451# Once this returns, just read the variable CDROM_ROOT for the location of the
1452# mounted CD. Note that you can only go forward in the CD list, so make sure
1453# you only call this function when you're done using the current CD.
1454cdrom_load_next_cd() {
1455 local var
1456 ((++CDROM_CURRENT_CD))
1457
1458 unset CDROM_ROOT
1459 var=CD_ROOT_${CDROM_CURRENT_CD}
1460 [[ -z ${!var} ]] && var="CD_ROOT"
1461 if [[ -z ${!var} ]] ; then
1462 var="CDROM_CHECK_${CDROM_CURRENT_CD}"
1463 _cdrom_locate_file_on_cd ${!var}
1464 else
1465 export CDROM_ROOT=${!var}
1466 fi
1467
1468 einfo "Found CD #${CDROM_CURRENT_CD} root at ${CDROM_ROOT}"
1469}
1470
1471# this is used internally by the cdrom_get_cds() and cdrom_load_next_cd()
1472# functions. this should *never* be called from an ebuild.
1473# all it does is try to locate a give file on a cd ... if the cd isn't
1474# found, then a message asking for the user to insert the cdrom will be
1475# displayed and we'll hang out here until:
1476# (1) the file is found on a mounted cdrom
1477# (2) the user hits CTRL+C
1478_cdrom_locate_file_on_cd() {
1479 local mline=""
1480 local showedmsg=0 showjolietmsg=0
1481
1482 while [[ -z ${CDROM_ROOT} ]] ; do
1483 local i=0
1484 local -a cdset=(${*//:/ })
1485 if [[ -n ${CDROM_SET} ]] ; then
1486 cdset=(${cdset[${CDROM_SET}]})
1487 fi
1488
1489 while [[ -n ${cdset[${i}]} ]] ; do
1490 local dir=$(dirname ${cdset[${i}]})
1491 local file=$(basename ${cdset[${i}]})
1492
1493 local point= node= fs= foo=
1494 while read point node fs foo ; do
1495 [[ " cd9660 iso9660 udf " != *" ${fs} "* ]] && \
1496 ! [[ ${fs} == "subfs" && ",${opts}," == *",fs=cdfss,"* ]] \
1497 && continue
1498 point=${point//\040/ }
1499 [[ ! -d ${point}/${dir} ]] && continue
1500 [[ -z $(find "${point}/${dir}" -maxdepth 1 -iname "${file}") ]] && continue
1501 export CDROM_ROOT=${point}
1502 export CDROM_SET=${i}
1503 export CDROM_MATCH=${cdset[${i}]}
1504 return
1505 done <<< "$(get_mounts)"
1506
1507 ((++i))
1508 done
1509
1510 echo
1511 if [[ ${showedmsg} -eq 0 ]] ; then
1512 if [[ ${CDROM_TOTAL_CDS} -eq 1 ]] ; then
1513 if [[ -z ${CDROM_NAME} ]] ; then
1514 einfo "Please insert+mount the cdrom for ${PN} now !"
1515 else
1516 einfo "Please insert+mount the ${CDROM_NAME} cdrom now !"
1517 fi
1518 else
1519 if [[ -z ${CDROM_NAME_1} ]] ; then
1520 einfo "Please insert+mount cd #${CDROM_CURRENT_CD} for ${PN} now !"
1521 else
1522 local var="CDROM_NAME_${CDROM_CURRENT_CD}"
1523 einfo "Please insert+mount the ${!var} cdrom now !"
1524 fi
1525 fi
1526 showedmsg=1
1527 fi
1528 einfo "Press return to scan for the cd again"
1529 einfo "or hit CTRL+C to abort the emerge."
1530 echo
1531 if [[ ${showjolietmsg} -eq 0 ]] ; then
1532 showjolietmsg=1
1533 else
1534 ewarn "If you are having trouble with the detection"
1535 ewarn "of your CD, it is possible that you do not have"
1536 ewarn "Joliet support enabled in your kernel. Please"
1537 ewarn "check that CONFIG_JOLIET is enabled in your kernel."
1538 ebeep 5
1539 fi
1540 read || die "something is screwed with your system"
1541 done
1542}
1543
1544# @FUNCTION: strip-linguas 959# @FUNCTION: strip-linguas
1545# @USAGE: [<allow LINGUAS>|<-i|-u> <directories of .po files>] 960# @USAGE: [<allow LINGUAS>|<-i|-u> <directories of .po files>]
1546# @DESCRIPTION: 961# @DESCRIPTION:
1547# Make sure that LINGUAS only contains languages that 962# Make sure that LINGUAS only contains languages that
1548# a package can support. The first form allows you to 963# a package can support. The first form allows you to
1553# of the lists. 968# of the lists.
1554strip-linguas() { 969strip-linguas() {
1555 local ls newls nols 970 local ls newls nols
1556 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then 971 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then
1557 local op=$1; shift 972 local op=$1; shift
1558 ls=$(find "$1" -name '*.po' -exec basename {} .po \;); shift 973 ls=$(find "$1" -name '*.po' -exec basename {} .po ';'); shift
1559 local d f 974 local d f
1560 for d in "$@" ; do 975 for d in "$@" ; do
1561 if [[ ${op} == "-u" ]] ; then 976 if [[ ${op} == "-u" ]] ; then
1562 newls=${ls} 977 newls=${ls}
1563 else 978 else
1564 newls="" 979 newls=""
1565 fi 980 fi
1566 for f in $(find "$d" -name '*.po' -exec basename {} .po \;) ; do 981 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do
1567 if [[ ${op} == "-i" ]] ; then 982 if [[ ${op} == "-i" ]] ; then
1568 hasq ${f} ${ls} && newls="${newls} ${f}" 983 has ${f} ${ls} && newls="${newls} ${f}"
1569 else 984 else
1570 hasq ${f} ${ls} || newls="${newls} ${f}" 985 has ${f} ${ls} || newls="${newls} ${f}"
1571 fi 986 fi
1572 done 987 done
1573 ls=${newls} 988 ls=${newls}
1574 done 989 done
1575 else 990 else
1577 fi 992 fi
1578 993
1579 nols="" 994 nols=""
1580 newls="" 995 newls=""
1581 for f in ${LINGUAS} ; do 996 for f in ${LINGUAS} ; do
1582 if hasq ${f} ${ls} ; then 997 if has ${f} ${ls} ; then
1583 newls="${newls} ${f}" 998 newls="${newls} ${f}"
1584 else 999 else
1585 nols="${nols} ${f}" 1000 nols="${nols} ${f}"
1586 fi 1001 fi
1587 done 1002 done
1588 [[ -n ${nols} ]] \ 1003 [[ -n ${nols} ]] \
1589 && ewarn "Sorry, but ${PN} does not support the LINGUAs:" ${nols} 1004 && ewarn "Sorry, but ${PN} does not support the LINGUAS:" ${nols}
1590 export LINGUAS=${newls:1} 1005 export LINGUAS=${newls:1}
1591} 1006}
1592 1007
1593# @FUNCTION: preserve_old_lib 1008# @FUNCTION: preserve_old_lib
1594# @USAGE: <libs to preserve> [more libs] 1009# @USAGE: <libs to preserve> [more libs]
1642 ewarn "the libraries are not being removed. You need to run revdep-rebuild" 1057 ewarn "the libraries are not being removed. You need to run revdep-rebuild"
1643 ewarn "in order to remove these old dependencies. If you do not have this" 1058 ewarn "in order to remove these old dependencies. If you do not have this"
1644 ewarn "helper program, simply emerge the 'gentoolkit' package." 1059 ewarn "helper program, simply emerge the 'gentoolkit' package."
1645 ewarn 1060 ewarn
1646 fi 1061 fi
1062 # temp hack for #348634 #357225
1063 [[ ${PN} == "mpfr" ]] && lib=${lib##*/}
1647 ewarn " # revdep-rebuild --library ${lib##*/}" 1064 ewarn " # revdep-rebuild --library '${lib}'"
1648 done 1065 done
1649 if [[ ${notice} -eq 1 ]] ; then 1066 if [[ ${notice} -eq 1 ]] ; then
1650 ewarn 1067 ewarn
1651 ewarn "Once you've finished running revdep-rebuild, it should be safe to" 1068 ewarn "Once you've finished running revdep-rebuild, it should be safe to"
1652 ewarn "delete the old libraries. Here is a copy & paste for the lazy:" 1069 ewarn "delete the old libraries. Here is a copy & paste for the lazy:"
1657} 1074}
1658 1075
1659# @FUNCTION: built_with_use 1076# @FUNCTION: built_with_use
1660# @USAGE: [--hidden] [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags> 1077# @USAGE: [--hidden] [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags>
1661# @DESCRIPTION: 1078# @DESCRIPTION:
1079#
1080# Deprecated: Use EAPI 2 use deps in DEPEND|RDEPEND and with has_version calls.
1081#
1662# A temporary hack until portage properly supports DEPENDing on USE 1082# A temporary hack until portage properly supports DEPENDing on USE
1663# flags being enabled in packages. This will check to see if the specified 1083# flags being enabled in packages. This will check to see if the specified
1664# DEPEND atom was built with the specified list of USE flags. The 1084# DEPEND atom was built with the specified list of USE flags. The
1665# --missing option controls the behavior if called on a package that does 1085# --missing option controls the behavior if called on a package that does
1666# not actually support the defined USE flags (aka listed in IUSE). 1086# not actually support the defined USE flags (aka listed in IUSE).
1794 ) || die 1214 ) || die
1795 else 1215 else
1796 newbin "${tmpwrapper}" "${wrapper}" || die 1216 newbin "${tmpwrapper}" "${wrapper}" || die
1797 fi 1217 fi
1798} 1218}
1219
1220# @FUNCTION: path_exists
1221# @USAGE: [-a|-o] <paths>
1222# @DESCRIPTION:
1223# Check if the specified paths exist. Works for all types of paths
1224# (files/dirs/etc...). The -a and -o flags control the requirements
1225# of the paths. They correspond to "and" and "or" logic. So the -a
1226# flag means all the paths must exist while the -o flag means at least
1227# one of the paths must exist. The default behavior is "and". If no
1228# paths are specified, then the return value is "false".
1229path_exists() {
1230 local opt=$1
1231 [[ ${opt} == -[ao] ]] && shift || opt="-a"
1232
1233 # no paths -> return false
1234 # same behavior as: [[ -e "" ]]
1235 [[ $# -eq 0 ]] && return 1
1236
1237 local p r=0
1238 for p in "$@" ; do
1239 [[ -e ${p} ]]
1240 : $(( r += $? ))
1241 done
1242
1243 case ${opt} in
1244 -a) return $(( r != 0 )) ;;
1245 -o) return $(( r == $# )) ;;
1246 esac
1247}
1248
1249# @FUNCTION: in_iuse
1250# @USAGE: <flag>
1251# @DESCRIPTION:
1252# Determines whether the given flag is in IUSE. Strips IUSE default prefixes
1253# as necessary.
1254#
1255# Note that this function should not be used in the global scope.
1256in_iuse() {
1257 debug-print-function ${FUNCNAME} "${@}"
1258 [[ ${#} -eq 1 ]] || die "Invalid args to ${FUNCNAME}()"
1259
1260 local flag=${1}
1261 local liuse=( ${IUSE} )
1262
1263 has "${flag}" "${liuse[@]#[+-]}"
1264}
1265
1266# @FUNCTION: use_if_iuse
1267# @USAGE: <flag>
1268# @DESCRIPTION:
1269# Return true if the given flag is in USE and IUSE.
1270#
1271# Note that this function should not be used in the global scope.
1272use_if_iuse() {
1273 in_iuse $1 || return 1
1274 use $1
1275}
1276
1277# @FUNCTION: usex
1278# @USAGE: <USE flag> [true output] [false output] [true suffix] [false suffix]
1279# @DESCRIPTION:
1280# If USE flag is set, echo [true output][true suffix] (defaults to "yes"),
1281# otherwise echo [false output][false suffix] (defaults to "no").
1282usex() { use "$1" && echo "${2-yes}$4" || echo "${3-no}$5" ; } #382963
1283
1284check_license() { die "you no longer need this as portage supports ACCEPT_LICENSE itself"; }
1285
1286fi

Legend:
Removed from v.1.304  
changed lines
  Added in v.1.386

  ViewVC Help
Powered by ViewVC 1.1.20