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

Diff of /eclass/eutils.eclass

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

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

Legend:
Removed from v.1.252  
changed lines
  Added in v.1.404

  ViewVC Help
Powered by ViewVC 1.1.20