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

Diff of /eclass/eutils.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20