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

Diff of /eclass/eutils.eclass

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

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

Legend:
Removed from v.1.237  
changed lines
  Added in v.1.416

  ViewVC Help
Powered by ViewVC 1.1.20