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

Diff of /eclass/eutils.eclass

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

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

Legend:
Removed from v.1.196  
changed lines
  Added in v.1.407

  ViewVC Help
Powered by ViewVC 1.1.20