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

Diff of /eclass/eutils.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20