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

Diff of /eclass/eutils.eclass

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

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

Legend:
Removed from v.1.212  
changed lines
  Added in v.1.444

  ViewVC Help
Powered by ViewVC 1.1.20