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

Diff of /eclass/eutils.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20