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

Diff of /eclass/eutils.eclass

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

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

Legend:
Removed from v.1.23  
changed lines
  Added in v.1.371

  ViewVC Help
Powered by ViewVC 1.1.20