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

Diff of /eclass/eutils.eclass

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

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

Legend:
Removed from v.1.161  
changed lines
  Added in v.1.400

  ViewVC Help
Powered by ViewVC 1.1.20