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

Diff of /eclass/eutils.eclass

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

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

Legend:
Removed from v.1.1.1.1  
changed lines
  Added in v.1.432

  ViewVC Help
Powered by ViewVC 1.1.20