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

Diff of /eclass/eutils.eclass

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

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

Legend:
Removed from v.1.321  
changed lines
  Added in v.1.442

  ViewVC Help
Powered by ViewVC 1.1.20