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

Diff of /eclass/eutils.eclass

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

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

Legend:
Removed from v.1.249  
changed lines
  Added in v.1.421

  ViewVC Help
Powered by ViewVC 1.1.20