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

Diff of /eclass/eutils.eclass

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

Revision 1.279 Revision 1.321
1# Copyright 1999-2006 Gentoo Foundation 1# Copyright 1999-2007 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.279 2007/04/25 09:14:35 carlo Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.321 2009/10/18 07:52:23 grobian Exp $
4
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.
4# 14#
5# This eclass is for general purpose functions that most ebuilds 15# Due to the nature of this eclass, some functions may have maintainers
6# have to implement themselves. 16# different from the overall eclass!
7#
8# NB: If you add anything, please comment it!
9#
10# Maintainer: see each individual function, base-system@gentoo.org as default
11 17
12inherit multilib portability 18inherit multilib portability
13 19
14DESCRIPTION="Based on the ${ECLASS} eclass" 20DESCRIPTION="Based on the ${ECLASS} eclass"
15 21
16# Wait for the supplied number of seconds. If no argument is supplied, defaults 22# @FUNCTION: epause
17# to five seconds. If the EPAUSE_IGNORE env var is set, don't wait. If we're not 23# @USAGE: [seconds]
18# outputting to a terminal, don't wait. For compatability purposes, the argument 24# @DESCRIPTION:
19# must be an integer greater than zero. 25# Sleep for the specified number of seconds (default of 5 seconds). Useful when
20# Bug 62950, Ciaran McCreesh <ciaranm@gentoo.org> (05 Sep 2004) 26# printing a message the user should probably be reading and often used in
27# conjunction with the ebeep function. If the EPAUSE_IGNORE env var is set,
28# don't wait at all.
21epause() { 29epause() {
22 [[ -z ${EPAUSE_IGNORE} ]] && sleep ${1:-5} 30 [[ -z ${EPAUSE_IGNORE} ]] && sleep ${1:-5}
23} 31}
24 32
25# Beep the specified number of times (defaults to five). If our output 33# @FUNCTION: ebeep
26# is not a terminal, don't beep. If the EBEEP_IGNORE env var is set, 34# @USAGE: [number of beeps]
35# @DESCRIPTION:
36# Issue the specified number of beeps (default of 5 beeps). Useful when
37# printing a message the user should probably be reading and often used in
38# conjunction with the epause function. If the EBEEP_IGNORE env var is set,
27# don't beep. 39# don't beep at all.
28# Bug 62950, Ciaran McCreesh <ciaranm@gentoo.org> (05 Sep 2004)
29ebeep() { 40ebeep() {
30 local n 41 local n
31 if [[ -z ${EBEEP_IGNORE} ]] ; then 42 if [[ -z ${EBEEP_IGNORE} ]] ; then
32 for ((n=1 ; n <= ${1:-5} ; n++)) ; do 43 for ((n=1 ; n <= ${1:-5} ; n++)) ; do
33 echo -ne "\a" 44 echo -ne "\a"
36 sleep 1 47 sleep 1
37 done 48 done
38 fi 49 fi
39} 50}
40 51
41# This function generate linker scripts in /usr/lib for dynamic 52# @FUNCTION: ecvs_clean
42# libs in /lib. This is to fix linking problems when you have 53# @USAGE: [list of dirs]
43# the .so in /lib, and the .a in /usr/lib. What happens is that 54# @DESCRIPTION:
44# in some cases when linking dynamic, the .a in /usr/lib is used 55# Remove CVS directories recursiveley. Useful when a source tarball contains
45# instead of the .so in /lib due to gcc/libtool tweaking ld's 56# internal CVS directories. Defaults to $PWD.
46# library search path. This cause many builds to fail. 57ecvs_clean() {
47# See bug #4411 for more info. 58 [[ -z $* ]] && set -- .
48# 59 find "$@" -type d -name 'CVS' -prune -print0 | xargs -0 rm -rf
49# To use, simply call: 60 find "$@" -type f -name '.cvs*' -print0 | xargs -0 rm -rf
50#
51# gen_usr_ldscript libfoo.so
52#
53# Note that you should in general use the unversioned name of
54# the library, as ldconfig should usually update it correctly
55# to point to the latest version of the library present.
56#
57# <azarah@gentoo.org> (26 Oct 2002)
58#
59gen_usr_ldscript() {
60 if [[ $(type -t _tc_gen_usr_ldscript) == "function" ]] ; then
61 _tc_gen_usr_ldscript "$@"
62 return $?
63 fi
64
65 ewarn "QA Notice: Please upgrade your ebuild to use toolchain-funcs"
66 ewarn "QA Notice: rather than gen_usr_ldscript() from eutils"
67
68 local lib libdir=$(get_libdir)
69 # Just make sure it exists
70 dodir /usr/${libdir}
71
72 for lib in "${@}" ; do
73 cat > "${D}/usr/${libdir}/${lib}" <<-END_LDSCRIPT
74 /* GNU ld script
75 Since Gentoo has critical dynamic libraries
76 in /lib, and the static versions in /usr/lib,
77 we need to have a "fake" dynamic lib in /usr/lib,
78 otherwise we run into linking problems.
79
80 See bug http://bugs.gentoo.org/4411 for more info.
81 */
82 GROUP ( /${libdir}/${lib} )
83 END_LDSCRIPT
84 fperms a+x "/usr/${libdir}/${lib}" || die "could not change perms on ${lib}"
85 done
86} 61}
87 62
63# @FUNCTION: esvn_clean
64# @USAGE: [list of dirs]
65# @DESCRIPTION:
66# Remove .svn directories recursiveley. Useful when a source tarball contains
67# internal Subversion directories. Defaults to $PWD.
68esvn_clean() {
69 [[ -z $* ]] && set -- .
70 find "$@" -type d -name '.svn' -prune -print0 | xargs -0 rm -rf
71}
88 72
89# Default directory where patches are located 73# Default directory where patches are located
90EPATCH_SOURCE="${WORKDIR}/patch" 74EPATCH_SOURCE="${WORKDIR}/patch"
91# Default extension for patches 75# Default extension for patches
92EPATCH_SUFFIX="patch.bz2" 76EPATCH_SUFFIX="patch.bz2"
93# Default options for patch 77# Default options for patch
94# Set -g0 to keep RCS, ClearCase, Perforce and SCCS happy. Bug #24571 78# Set -g0 to keep RCS, ClearCase, Perforce and SCCS happy. Bug #24571
95# Set --no-backup-if-mismatch so we don't leave '.orig' files behind. 79# Set --no-backup-if-mismatch so we don't leave '.orig' files behind.
96# Set -E to automatically remove empty files. 80# Set -E to automatically remove empty files.
97EPATCH_OPTS="-g0 -E --no-backup-if-mismatch" 81EPATCH_OPTS="-g0 -E --no-backup-if-mismatch"
98# List of patches not to apply. Not this is only file names, 82# List of patches not to apply. Note this is only file names,
99# and not the full path .. 83# and not the full path ..
100EPATCH_EXCLUDE="" 84EPATCH_EXCLUDE=""
101# Change the printed message for a single patch. 85# Change the printed message for a single patch.
102EPATCH_SINGLE_MSG="" 86EPATCH_SINGLE_MSG=""
103# Change the printed message for multiple patches. 87# Change the printed message for multiple patches.
121# bug they should be left as is to ensure an ebuild can rely on 105# bug they should be left as is to ensure an ebuild can rely on
122# them for. 106# them for.
123# 107#
124# Patches are applied in current directory. 108# Patches are applied in current directory.
125# 109#
126# Bulk Patches should preferibly have the form of: 110# Bulk Patches should preferably have the form of:
127# 111#
128# ??_${ARCH}_foo.${EPATCH_SUFFIX} 112# ??_${ARCH}_foo.${EPATCH_SUFFIX}
129# 113#
130# For example: 114# For example:
131# 115#
180 local EPATCH_SOURCE="$1/*" 164 local EPATCH_SOURCE="$1/*"
181 else 165 else
182 local EPATCH_SOURCE="$1/*.${EPATCH_SUFFIX}" 166 local EPATCH_SOURCE="$1/*.${EPATCH_SUFFIX}"
183 fi 167 fi
184 else 168 else
185 if [ ! -d ${EPATCH_SOURCE} ] || [ -n "$1" ] 169 if [[ ! -d ${EPATCH_SOURCE} ]] || [[ -n $1 ]] ; then
186 then
187 if [ -n "$1" -a "${EPATCH_SOURCE}" = "${WORKDIR}/patch" ] 170 if [ -n "$1" -a "${EPATCH_SOURCE}" = "${WORKDIR}/patch" ]
188 then 171 then
189 EPATCH_SOURCE="$1" 172 EPATCH_SOURCE="$1"
190 fi 173 fi
191 174
200 183
201 local EPATCH_SOURCE="${EPATCH_SOURCE}/*.${EPATCH_SUFFIX}" 184 local EPATCH_SOURCE="${EPATCH_SOURCE}/*.${EPATCH_SUFFIX}"
202 fi 185 fi
203 186
204 case ${EPATCH_SUFFIX##*\.} in 187 case ${EPATCH_SUFFIX##*\.} in
188 xz)
189 PIPE_CMD="xz -dc"
190 PATCH_SUFFIX="xz"
191 ;;
192 lzma)
193 PIPE_CMD="lzma -dc"
194 PATCH_SUFFIX="lzma"
195 ;;
205 bz2) 196 bz2)
206 PIPE_CMD="bzip2 -dc" 197 PIPE_CMD="bzip2 -dc"
207 PATCH_SUFFIX="bz2" 198 PATCH_SUFFIX="bz2"
208 ;; 199 ;;
209 gz|Z|z) 200 gz|Z|z)
259 fi 250 fi
260 251
261 echo "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 252 echo "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
262 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 253 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
263 254
255 # Decompress the patch if need be
256 if [[ ${PATCH_SUFFIX} != "patch" ]] ; then
257 echo -n "PIPE_COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
258 echo "${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
259
260 if ! (${PIPE_CMD} ${x} > ${PATCH_TARGET}) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1 ; then
261 echo
262 eerror "Could not extract patch!"
263 #die "Could not extract patch!"
264 count=5
265 break
266 fi
267 else
268 PATCH_TARGET="${x}"
269 fi
270
271 # Check for absolute paths in patches. If sandbox is disabled,
272 # people could (accidently) patch files in the root filesystem.
273 # Or trigger other unpleasantries #237667. So disallow -p0 on
274 # such patches.
275 local abs_paths=$(egrep -n '^[-+]{3} /' "${PATCH_TARGET}" | awk '$2 != "/dev/null" { print }')
276 if [[ -n ${abs_paths} ]] ; then
277 count=1
278 echo "NOTE: skipping -p0 due to absolute paths in patch:" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
279 echo "${abs_paths}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
280 fi
281
264 # Allow for prefix to differ ... im lazy, so shoot me :/ 282 # Allow for prefix to differ ... im lazy, so shoot me :/
265 while [ "${count}" -lt 5 ] 283 while [ "${count}" -lt 5 ]
266 do 284 do
267 # Generate some useful debug info ... 285 # Generate some useful debug info ...
268 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 286 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
269 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 287 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
270 288
271 if [ "${PATCH_SUFFIX}" != "patch" ]
272 then
273 echo -n "PIPE_COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
274 echo "${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
275 else
276 PATCH_TARGET="${x}"
277 fi
278
279 echo -n "PATCH COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 289 echo -n "PATCH COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
280 echo "patch -p${count} ${popts} < ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 290 echo "patch -p${count} ${popts} < ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
281 291
282 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 292 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
283 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 293 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
284
285 if [ "${PATCH_SUFFIX}" != "patch" ]
286 then
287 if ! (${PIPE_CMD} ${x} > ${PATCH_TARGET}) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1
288 then
289 echo
290 eerror "Could not extract patch!"
291 #die "Could not extract patch!"
292 count=5
293 break
294 fi
295 fi
296 294
297 if (cat ${PATCH_TARGET} | patch -p${count} ${popts} --dry-run -f ; _epatch_assert) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1 295 if (cat ${PATCH_TARGET} | patch -p${count} ${popts} --dry-run -f ; _epatch_assert) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1
298 then 296 then
299 _epatch_draw_line "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real 297 _epatch_draw_line "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
300 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real 298 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
349 if [ "${SINGLE_PATCH}" = "no" ] 347 if [ "${SINGLE_PATCH}" = "no" ]
350 then 348 then
351 einfo "Done with patching" 349 einfo "Done with patching"
352 fi 350 fi
353} 351}
352epatch_user() {
353 [[ $# -ne 0 ]] && die "epatch_user takes no options"
354 354
355 # don't clobber any EPATCH vars that the parent might want
356 local EPATCH_SOURCE check base=${PORTAGE_CONFIGROOT}/etc/portage/patches
357 for check in {${CATEGORY}/${PF},${CATEGORY}/${P},${CATEGORY}/${PN}}; do
358 EPATCH_SOURCE=${base}/${CTARGET}/${check}
359 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${CHOST}/${check}
360 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${check}
361 if [[ -d ${EPATCH_SOURCE} ]] ; then
362 EPATCH_SOURCE=${EPATCH_SOURCE} \
363 EPATCH_SUFFIX="patch" \
364 EPATCH_FORCE="yes" \
365 EPATCH_MULTI_MSG="Applying user patches from ${EPATCH_SOURCE} ..." \
366 epatch
367 break
368 fi
369 done
370}
371
372# @FUNCTION: emktemp
373# @USAGE: [temp dir]
374# @DESCRIPTION:
355# Cheap replacement for when debianutils (and thus mktemp) 375# Cheap replacement for when debianutils (and thus mktemp)
356# does not exist on the users system 376# does not exist on the users system.
357# vapier@gentoo.org
358#
359# Takes just 1 optional parameter (the directory to create tmpfile in)
360emktemp() { 377emktemp() {
361 local exe="touch" 378 local exe="touch"
362 [[ $1 == -d ]] && exe="mkdir" && shift 379 [[ $1 == -d ]] && exe="mkdir" && shift
363 local topdir=$1 380 local topdir=$1
364 381
366 [[ -z ${T} ]] \ 383 [[ -z ${T} ]] \
367 && topdir="/tmp" \ 384 && topdir="/tmp" \
368 || topdir=${T} 385 || topdir=${T}
369 fi 386 fi
370 387
371 if [[ -z $(type -p mktemp) ]] ; then 388 if ! type -P mktemp > /dev/null ; then
389 # system lacks `mktemp` so we have to fake it
372 local tmp=/ 390 local tmp=/
373 while [[ -e ${tmp} ]] ; do 391 while [[ -e ${tmp} ]] ; do
374 tmp=${topdir}/tmp.${RANDOM}.${RANDOM}.${RANDOM} 392 tmp=${topdir}/tmp.${RANDOM}.${RANDOM}.${RANDOM}
375 done 393 done
376 ${exe} "${tmp}" || ${exe} -p "${tmp}" 394 ${exe} "${tmp}" || ${exe} -p "${tmp}"
377 echo "${tmp}" 395 echo "${tmp}"
378 else 396 else
397 # the args here will give slightly wierd names on BSD,
398 # but should produce a usable file on all userlands
379 if [[ ${exe} == "touch" ]] ; then 399 if [[ ${exe} == "touch" ]] ; then
380 [[ ${USERLAND} == "GNU" ]] \
381 && mktemp -p "${topdir}" \
382 || TMPDIR="${topdir}" mktemp -t tmp 400 TMPDIR="${topdir}" mktemp -t tmp.XXXXXXXXXX
383 else 401 else
384 [[ ${USERLAND} == "GNU" ]] \
385 && mktemp -d "${topdir}" \
386 || TMPDIR="${topdir}" mktemp -dt tmp 402 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX
387 fi
388 fi 403 fi
404 fi
389} 405}
390 406
407# @FUNCTION: egetent
408# @USAGE: <database> <key>
409# @MAINTAINER:
410# base-system@gentoo.org (Linux)
411# Joe Jezak <josejx@gmail.com> (OS X)
412# usata@gentoo.org (OS X)
413# Aaron Walker <ka0ttic@gentoo.org> (FreeBSD)
414# @DESCRIPTION:
391# Small wrapper for getent (Linux), nidump (Mac OS X), 415# Small wrapper for getent (Linux),
416# nidump (< Mac OS X 10.5), dscl (Mac OS X 10.5),
392# and pw (FreeBSD) used in enewuser()/enewgroup() 417# and pw (FreeBSD) used in enewuser()/enewgroup()
393# Joe Jezak <josejx@gmail.com> and usata@gentoo.org
394# FBSD stuff: Aaron Walker <ka0ttic@gentoo.org>
395#
396# egetent(database, key)
397egetent() { 418egetent() {
398 case ${CHOST} in 419 case ${CHOST} in
399 *-darwin*) 420 *-darwin[678])
400 case "$2" in 421 case "$2" in
401 *[!0-9]*) # Non numeric 422 *[!0-9]*) # Non numeric
402 nidump $1 . | awk -F":" "{ if (\$1 ~ /^$2$/) {print \$0;exit;} }" 423 nidump $1 . | awk -F":" "{ if (\$1 ~ /^$2$/) {print \$0;exit;} }"
403 ;; 424 ;;
404 *) # Numeric 425 *) # Numeric
405 nidump $1 . | awk -F":" "{ if (\$3 == $2) {print \$0;exit;} }" 426 nidump $1 . | awk -F":" "{ if (\$3 == $2) {print \$0;exit;} }"
427 ;;
428 esac
429 ;;
430 *-darwin*)
431 local mytype=$1
432 [[ "passwd" == $mytype ]] && mytype="Users"
433 [[ "group" == $mytype ]] && mytype="Groups"
434 case "$2" in
435 *[!0-9]*) # Non numeric
436 dscl . -read /$mytype/$2 2>/dev/null |grep RecordName
437 ;;
438 *) # Numeric
439 local mykey="UniqueID"
440 [[ $mytype == "Groups" ]] && mykey="PrimaryGroupID"
441 dscl . -search /$mytype $mykey $2 2>/dev/null
406 ;; 442 ;;
407 esac 443 esac
408 ;; 444 ;;
409 *-freebsd*|*-dragonfly*) 445 *-freebsd*|*-dragonfly*)
410 local opts action="user" 446 local opts action="user"
425 getent "$1" "$2" 461 getent "$1" "$2"
426 ;; 462 ;;
427 esac 463 esac
428} 464}
429 465
430# Simplify/standardize adding users to the system 466# @FUNCTION: enewuser
431# vapier@gentoo.org 467# @USAGE: <user> [uid] [shell] [homedir] [groups] [params]
432# 468# @DESCRIPTION:
433# enewuser(username, uid, shell, homedir, groups, extra options) 469# Same as enewgroup, you are not required to understand how to properly add
434# 470# a user to the system. The only required parameter is the username.
435# Default values if you do not specify any: 471# Default uid is (pass -1 for this) next available, default shell is
436# username: REQUIRED ! 472# /bin/false, default homedir is /dev/null, there are no default groups,
437# uid: next available (see useradd(8)) 473# and default params sets the comment as 'added by portage for ${PN}'.
438# note: pass -1 to get default behavior
439# shell: /bin/false
440# homedir: /dev/null
441# groups: none
442# extra: comment of 'added by portage for ${PN}'
443enewuser() { 474enewuser() {
444 case ${EBUILD_PHASE} in 475 case ${EBUILD_PHASE} in
445 unpack|compile|test|install) 476 unpack|compile|test|install)
446 eerror "'enewuser()' called from '${EBUILD_PHASE}()' which is not a pkg_* function." 477 eerror "'enewuser()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
447 eerror "Package fails at QA and at life. Please file a bug." 478 eerror "Package fails at QA and at life. Please file a bug."
615 fi 646 fi
616 ;; 647 ;;
617 648
618 *) 649 *)
619 if [[ -z $@ ]] ; then 650 if [[ -z $@ ]] ; then
620 useradd ${opts} ${euser} \ 651 useradd ${opts} \
621 -c "added by portage for ${PN}" \ 652 -c "added by portage for ${PN}" \
653 ${euser} \
622 || die "enewuser failed" 654 || die "enewuser failed"
623 else 655 else
624 einfo " - Extra: $@" 656 einfo " - Extra: $@"
625 useradd ${opts} ${euser} "$@" \ 657 useradd ${opts} "$@" \
658 ${euser} \
626 || die "enewuser failed" 659 || die "enewuser failed"
627 fi 660 fi
628 ;; 661 ;;
629 esac 662 esac
630 663
636 fi 669 fi
637 670
638 export SANDBOX_ON=${oldsandbox} 671 export SANDBOX_ON=${oldsandbox}
639} 672}
640 673
641# Simplify/standardize adding groups to the system 674# @FUNCTION: enewgroup
642# vapier@gentoo.org 675# @USAGE: <group> [gid]
643# 676# @DESCRIPTION:
644# enewgroup(group, gid) 677# This function does not require you to understand how to properly add a
645# 678# group to the system. Just give it a group name to add and enewgroup will
646# Default values if you do not specify any: 679# do the rest. You may specify the gid for the group or allow the group to
647# groupname: REQUIRED ! 680# allocate the next available one.
648# gid: next available (see groupadd(8))
649# extra: none
650enewgroup() { 681enewgroup() {
651 case ${EBUILD_PHASE} in 682 case ${EBUILD_PHASE} in
652 unpack|compile|test|install) 683 unpack|compile|test|install)
653 eerror "'enewgroup()' called from '${EBUILD_PHASE}()' which is not a pkg_* function." 684 eerror "'enewgroup()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
654 eerror "Package fails at QA and at life. Please file a bug." 685 eerror "Package fails at QA and at life. Please file a bug."
750 ;; 781 ;;
751 esac 782 esac
752 export SANDBOX_ON="${oldsandbox}" 783 export SANDBOX_ON="${oldsandbox}"
753} 784}
754 785
755# Simple script to replace 'dos2unix' binaries 786# @FUNCTION: edos2unix
756# vapier@gentoo.org 787# @USAGE: <file> [more files ...]
757# 788# @DESCRIPTION:
758# edos2unix(file, <more files> ...) 789# A handy replacement for dos2unix, recode, fixdos, etc... This allows you
790# to remove all of these text utilities from DEPEND variables because this
791# is a script based solution. Just give it a list of files to convert and
792# they will all be changed from the DOS CRLF format to the UNIX LF format.
759edos2unix() { 793edos2unix() {
760 echo "$@" | xargs sed -i 's/\r$//' 794 echo "$@" | xargs sed -i 's/\r$//'
761} 795}
762
763
764##############################################################
765# START: Handle .desktop files and menu entries #
766# maybe this should be separated into a new eclass some time #
767# lanius@gentoo.org #
768##############################################################
769 796
770# Make a desktop file ! 797# Make a desktop file !
771# Great for making those icons in kde/gnome startmenu ! 798# Great for making those icons in kde/gnome startmenu !
772# Amaze your friends ! Get the women ! Join today ! 799# Amaze your friends ! Get the women ! Join today !
773# 800#
777# name: the name that will show up in the menu 804# name: the name that will show up in the menu
778# icon: give your little like a pretty little icon ... 805# icon: give your little like a pretty little icon ...
779# this can be relative (to /usr/share/pixmaps) or 806# this can be relative (to /usr/share/pixmaps) or
780# a full path to an icon 807# a full path to an icon
781# type: what kind of application is this ? for categories: 808# type: what kind of application is this ? for categories:
782# http://www.freedesktop.org/Standards/desktop-entry-spec 809# http://standards.freedesktop.org/menu-spec/latest/apa.html
783# path: if your app needs to startup in a specific dir 810# path: if your app needs to startup in a specific dir
784make_desktop_entry() { 811make_desktop_entry() {
785 [[ -z $1 ]] && eerror "make_desktop_entry: You must specify the executable" && return 1 812 [[ -z $1 ]] && eerror "make_desktop_entry: You must specify the executable" && return 1
786 813
787 local exec=${1} 814 local exec=${1}
788 local name=${2:-${PN}} 815 local name=${2:-${PN}}
789 local icon=${3:-${PN}.png} 816 local icon=${3:-${PN}}
790 local type=${4} 817 local type=${4}
791 local path=${5} 818 local path=${5}
792 819
793 if [[ -z ${type} ]] ; then 820 if [[ -z ${type} ]] ; then
794 local catmaj=${CATEGORY%%-*} 821 local catmaj=${CATEGORY%%-*}
795 local catmin=${CATEGORY##*-} 822 local catmin=${CATEGORY##*-}
796 case ${catmaj} in 823 case ${catmaj} in
797 app) 824 app)
798 case ${catmin} in 825 case ${catmin} in
826 accessibility) type=Accessibility;;
799 admin) type=System;; 827 admin) type=System;;
828 antivirus) type=System;;
829 arch) type=Archiving;;
830 backup) type=Archiving;;
800 cdr) type=DiscBurning;; 831 cdr) type=DiscBurning;;
801 dicts) type=Dictionary;; 832 dicts) type=Dictionary;;
833 doc) type=Documentation;;
802 editors) type=TextEditor;; 834 editors) type=TextEditor;;
803 emacs) type=TextEditor;; 835 emacs) type=TextEditor;;
804 emulation) type=Emulator;; 836 emulation) type=Emulator;;
805 laptop) type=HardwareSettings;; 837 laptop) type=HardwareSettings;;
806 office) type=Office;; 838 office) type=Office;;
839 pda) type=PDA;;
807 vim) type=TextEditor;; 840 vim) type=TextEditor;;
808 xemacs) type=TextEditor;; 841 xemacs) type=TextEditor;;
809 *) type=;; 842 *) type=;;
810 esac 843 esac
811 ;; 844 ;;
817 games) 850 games)
818 case ${catmin} in 851 case ${catmin} in
819 action|fps) type=ActionGame;; 852 action|fps) type=ActionGame;;
820 arcade) type=ArcadeGame;; 853 arcade) type=ArcadeGame;;
821 board) type=BoardGame;; 854 board) type=BoardGame;;
855 emulation) type=Emulator;;
822 kids) type=KidsGame;; 856 kids) type=KidsGame;;
823 emulation) type=Emulator;;
824 puzzle) type=LogicGame;; 857 puzzle) type=LogicGame;;
858 roguelike) type=RolePlaying;;
825 rpg) type=RolePlaying;; 859 rpg) type=RolePlaying;;
826 roguelike) type=RolePlaying;;
827 simulation) type=Simulation;; 860 simulation) type=Simulation;;
828 sports) type=SportsGame;; 861 sports) type=SportsGame;;
829 strategy) type=StrategyGame;; 862 strategy) type=StrategyGame;;
830 *) type=;; 863 *) type=;;
831 esac 864 esac
832 type="Game;${type}" 865 type="Game;${type}"
866 ;;
867
868 gnome)
869 type="Gnome;GTK"
870 ;;
871
872 kde)
873 type="KDE;Qt"
833 ;; 874 ;;
834 875
835 mail) 876 mail)
836 type="Network;Email" 877 type="Network;Email"
837 ;; 878 ;;
863 type="Network;${type}" 904 type="Network;${type}"
864 ;; 905 ;;
865 906
866 sci) 907 sci)
867 case ${catmin} in 908 case ${catmin} in
868 astro*) type=Astronomy;; 909 astro*) type=Astronomy;;
869 bio*) type=Biology;; 910 bio*) type=Biology;;
870 calc*) type=Calculator;; 911 calc*) type=Calculator;;
871 chem*) type=Chemistry;; 912 chem*) type=Chemistry;;
913 elec*) type=Electronics;;
872 geo*) type=Geology;; 914 geo*) type=Geology;;
873 math*) type=Math;; 915 math*) type=Math;;
916 physics) type=Physics;;
917 visual*) type=DataVisualization;;
874 *) type=;; 918 *) type=;;
875 esac 919 esac
876 type="Science;${type}" 920 type="Science;${type}"
921 ;;
922
923 sys)
924 type="System"
877 ;; 925 ;;
878 926
879 www) 927 www)
880 case ${catmin} in 928 case ${catmin} in
881 client) type=WebBrowser;; 929 client) type=WebBrowser;;
897 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop" 945 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop"
898 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop 946 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop
899 947
900 cat <<-EOF > "${desktop}" 948 cat <<-EOF > "${desktop}"
901 [Desktop Entry] 949 [Desktop Entry]
902 Encoding=UTF-8
903 Version=0.9.2
904 Name=${name} 950 Name=${name}
905 Type=Application 951 Type=Application
906 Comment=${DESCRIPTION} 952 Comment=${DESCRIPTION}
907 Exec=${exec} 953 Exec=${exec}
908 TryExec=${exec%% *} 954 TryExec=${exec%% *}
909 Path=${path}
910 Icon=${icon} 955 Icon=${icon}
911 Categories=Application;${type}; 956 Categories=${type};
912 EOF 957 EOF
958
959 [[ ${path} ]] && echo "Path=${path}" >> "${desktop}"
913 960
914 ( 961 (
915 # wrap the env here so that the 'insinto' call 962 # wrap the env here so that the 'insinto' call
916 # doesn't corrupt the env of the caller 963 # doesn't corrupt the env of the caller
917 insinto /usr/share/applications 964 insinto /usr/share/applications
918 doins "${desktop}" 965 doins "${desktop}"
919 ) 966 )
920} 967}
921 968
922 969# @FUNCTION: validate_desktop_entries
970# @USAGE: [directories]
971# @MAINTAINER:
972# Carsten Lohrke <carlo@gentoo.org>
973# @DESCRIPTION:
923# Validate desktop entries using desktop-file-utils 974# Validate desktop entries using desktop-file-utils
924# Carsten Lohrke <carlo@gentoo.org>
925#
926# Usage: validate_desktop_entries [directory ...]
927
928validate_desktop_entries() { 975validate_desktop_entries() {
929 if [[ -x /usr/bin/desktop-file-validate ]] ; then 976 if [[ -x /usr/bin/desktop-file-validate ]] ; then
930 einfo "Checking desktop entry validity" 977 einfo "Checking desktop entry validity"
931 local directories="" 978 local directories=""
932 for d in /usr/share/applications $@ ; do 979 for d in /usr/share/applications $@ ; do
945 else 992 else
946 einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo." 993 einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo."
947 fi 994 fi
948} 995}
949 996
950 997# @FUNCTION: make_session_desktop
951# Make a GDM/KDM Session file 998# @USAGE: <title> <command> [command args...]
999# @DESCRIPTION:
1000# Make a GDM/KDM Session file. The title is the file to execute to start the
1001# Window Manager. The command is the name of the Window Manager.
952# 1002#
953# make_session_desktop(<title>, <command>) 1003# You can set the name of the file via the ${wm} variable.
954# title: File to execute to start the Window Manager
955# command: Name of the Window Manager
956
957make_session_desktop() { 1004make_session_desktop() {
958 [[ -z $1 ]] && eerror "make_session_desktop: You must specify the title" && return 1 1005 [[ -z $1 ]] && eerror "$0: You must specify the title" && return 1
959 [[ -z $2 ]] && eerror "make_session_desktop: You must specify the command" && return 1 1006 [[ -z $2 ]] && eerror "$0: You must specify the command" && return 1
960 1007
961 local title=$1 1008 local title=$1
962 local command=$2 1009 local command=$2
963 local desktop=${T}/${wm}.desktop 1010 local desktop=${T}/${wm:-${PN}}.desktop
1011 shift 2
964 1012
965 cat <<-EOF > "${desktop}" 1013 cat <<-EOF > "${desktop}"
966 [Desktop Entry] 1014 [Desktop Entry]
967 Encoding=UTF-8
968 Name=${title} 1015 Name=${title}
969 Comment=This session logs you into ${title} 1016 Comment=This session logs you into ${title}
970 Exec=${command} 1017 Exec=${command} $*
971 TryExec=${command} 1018 TryExec=${command}
972 Type=Application 1019 Type=XSession
973 EOF 1020 EOF
974 1021
975 ( 1022 (
976 # wrap the env here so that the 'insinto' call 1023 # wrap the env here so that the 'insinto' call
977 # doesn't corrupt the env of the caller 1024 # doesn't corrupt the env of the caller
978 insinto /usr/share/xsessions 1025 insinto /usr/share/xsessions
979 doins "${desktop}" 1026 doins "${desktop}"
980 ) 1027 )
981} 1028}
982 1029
1030# @FUNCTION: domenu
1031# @USAGE: <menus>
1032# @DESCRIPTION:
1033# Install the list of .desktop menu files into the appropriate directory
1034# (/usr/share/applications).
983domenu() { 1035domenu() {
984 ( 1036 (
985 # wrap the env here so that the 'insinto' call 1037 # wrap the env here so that the 'insinto' call
986 # doesn't corrupt the env of the caller 1038 # doesn't corrupt the env of the caller
987 local i j ret=0 1039 local i j ret=0
993 elif [[ -d ${i} ]] ; then 1045 elif [[ -d ${i} ]] ; then
994 for j in "${i}"/*.desktop ; do 1046 for j in "${i}"/*.desktop ; do
995 doins "${j}" 1047 doins "${j}"
996 ((ret+=$?)) 1048 ((ret+=$?))
997 done 1049 done
1050 else
1051 ((++ret))
998 fi 1052 fi
999 done 1053 done
1000 exit ${ret} 1054 exit ${ret}
1001 ) 1055 )
1002} 1056}
1057
1058# @FUNCTION: newmenu
1059# @USAGE: <menu> <newname>
1060# @DESCRIPTION:
1061# Like all other new* functions, install the specified menu as newname.
1003newmenu() { 1062newmenu() {
1004 ( 1063 (
1005 # wrap the env here so that the 'insinto' call 1064 # wrap the env here so that the 'insinto' call
1006 # doesn't corrupt the env of the caller 1065 # doesn't corrupt the env of the caller
1007 insinto /usr/share/applications 1066 insinto /usr/share/applications
1008 newins "$@" 1067 newins "$@"
1009 ) 1068 )
1010} 1069}
1011 1070
1071# @FUNCTION: doicon
1072# @USAGE: <list of icons>
1073# @DESCRIPTION:
1074# Install the list of icons into the icon directory (/usr/share/pixmaps).
1075# This is useful in conjunction with creating desktop/menu files.
1012doicon() { 1076doicon() {
1013 ( 1077 (
1014 # wrap the env here so that the 'insinto' call 1078 # wrap the env here so that the 'insinto' call
1015 # doesn't corrupt the env of the caller 1079 # doesn't corrupt the env of the caller
1016 local i j ret 1080 local i j ret
1022 elif [[ -d ${i} ]] ; then 1086 elif [[ -d ${i} ]] ; then
1023 for j in "${i}"/*.png ; do 1087 for j in "${i}"/*.png ; do
1024 doins "${j}" 1088 doins "${j}"
1025 ((ret+=$?)) 1089 ((ret+=$?))
1026 done 1090 done
1091 else
1092 ((++ret))
1027 fi 1093 fi
1028 done 1094 done
1029 exit ${ret} 1095 exit ${ret}
1030 ) 1096 )
1031} 1097}
1098
1099# @FUNCTION: newicon
1100# @USAGE: <icon> <newname>
1101# @DESCRIPTION:
1102# Like all other new* functions, install the specified icon as newname.
1032newicon() { 1103newicon() {
1033 ( 1104 (
1034 # wrap the env here so that the 'insinto' call 1105 # wrap the env here so that the 'insinto' call
1035 # doesn't corrupt the env of the caller 1106 # doesn't corrupt the env of the caller
1036 insinto /usr/share/pixmaps 1107 insinto /usr/share/pixmaps
1037 newins "$@" 1108 newins "$@"
1038 ) 1109 )
1039} 1110}
1040
1041##############################################################
1042# END: Handle .desktop files and menu entries #
1043##############################################################
1044
1045 1111
1046# for internal use only (unpack_pdv and unpack_makeself) 1112# for internal use only (unpack_pdv and unpack_makeself)
1047find_unpackable_file() { 1113find_unpackable_file() {
1048 local src=$1 1114 local src=$1
1049 if [[ -z ${src} ]] ; then 1115 if [[ -z ${src} ]] ; then
1059 fi 1125 fi
1060 [[ ! -e ${src} ]] && return 1 1126 [[ ! -e ${src} ]] && return 1
1061 echo "${src}" 1127 echo "${src}"
1062} 1128}
1063 1129
1130# @FUNCTION: unpack_pdv
1131# @USAGE: <file to unpack> <size of off_t>
1132# @DESCRIPTION:
1064# Unpack those pesky pdv generated files ... 1133# Unpack those pesky pdv generated files ...
1065# They're self-unpacking programs with the binary package stuffed in 1134# They're self-unpacking programs with the binary package stuffed in
1066# the middle of the archive. Valve seems to use it a lot ... too bad 1135# the middle of the archive. Valve seems to use it a lot ... too bad
1067# it seems to like to segfault a lot :(. So lets take it apart ourselves. 1136# it seems to like to segfault a lot :(. So lets take it apart ourselves.
1068# 1137#
1069# Usage: unpack_pdv [file to unpack] [size of off_t]
1070# - you have to specify the off_t size ... i have no idea how to extract that 1138# You have to specify the off_t size ... I have no idea how to extract that
1071# information out of the binary executable myself. basically you pass in 1139# information out of the binary executable myself. Basically you pass in
1072# the size of the off_t type (in bytes) on the machine that built the pdv 1140# the size of the off_t type (in bytes) on the machine that built the pdv
1141# archive.
1142#
1073# archive. one way to determine this is by running the following commands: 1143# One way to determine this is by running the following commands:
1144#
1145# @CODE
1074# strings <pdv archive> | grep lseek 1146# strings <pdv archive> | grep lseek
1075# strace -elseek <pdv archive> 1147# strace -elseek <pdv archive>
1148# @CODE
1149#
1076# basically look for the first lseek command (we do the strings/grep because 1150# Basically look for the first lseek command (we do the strings/grep because
1077# sometimes the function call is _llseek or something) and steal the 2nd 1151# sometimes the function call is _llseek or something) and steal the 2nd
1078# parameter. here is an example: 1152# parameter. Here is an example:
1153#
1154# @CODE
1079# root@vapier 0 pdv_unpack # strings hldsupdatetool.bin | grep lseek 1155# vapier@vapier 0 pdv_unpack # strings hldsupdatetool.bin | grep lseek
1080# lseek 1156# lseek
1081# root@vapier 0 pdv_unpack # strace -elseek ./hldsupdatetool.bin 1157# vapier@vapier 0 pdv_unpack # strace -elseek ./hldsupdatetool.bin
1082# lseek(3, -4, SEEK_END) = 2981250 1158# lseek(3, -4, SEEK_END) = 2981250
1159# @CODE
1160#
1083# thus we would pass in the value of '4' as the second parameter. 1161# Thus we would pass in the value of '4' as the second parameter.
1084unpack_pdv() { 1162unpack_pdv() {
1085 local src=$(find_unpackable_file "$1") 1163 local src=$(find_unpackable_file "$1")
1086 local sizeoff_t=$2 1164 local sizeoff_t=$2
1087 1165
1088 [[ -z ${src} ]] && die "Could not locate source for '$1'" 1166 [[ -z ${src} ]] && die "Could not locate source for '$1'"
1150 true 1228 true
1151 #[ -s "${datafile}" ] || die "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')" 1229 #[ -s "${datafile}" ] || die "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
1152 #assert "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')" 1230 #assert "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
1153} 1231}
1154 1232
1233# @FUNCTION: unpack_makeself
1234# @USAGE: [file to unpack] [offset] [tail|dd]
1235# @DESCRIPTION:
1155# Unpack those pesky makeself generated files ... 1236# Unpack those pesky makeself generated files ...
1156# They're shell scripts with the binary package tagged onto 1237# They're shell scripts with the binary package tagged onto
1157# the end of the archive. Loki utilized the format as does 1238# the end of the archive. Loki utilized the format as does
1158# many other game companies. 1239# many other game companies.
1159# 1240#
1160# Usage: unpack_makeself [file to unpack] [offset] [tail|dd] 1241# If the file is not specified, then ${A} is used. If the
1161# - If the file is not specified then unpack will utilize ${A}.
1162# - If the offset is not specified then we will attempt to extract 1242# offset is not specified then we will attempt to extract
1163# the proper offset from the script itself. 1243# the proper offset from the script itself.
1164unpack_makeself() { 1244unpack_makeself() {
1165 local src_input=${1:-${A}} 1245 local src_input=${1:-${A}}
1166 local src=$(find_unpackable_file "${src_input}") 1246 local src=$(find_unpackable_file "${src_input}")
1167 local skip=$2 1247 local skip=$2
1168 local exe=$3 1248 local exe=$3
1238 ;; 1318 ;;
1239 esac 1319 esac
1240 assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})" 1320 assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})"
1241} 1321}
1242 1322
1323# @FUNCTION: check_license
1324# @USAGE: [license]
1325# @DESCRIPTION:
1243# Display a license for user to accept. 1326# Display a license for user to accept. If no license is
1244#
1245# Usage: check_license [license]
1246# - If the file is not specified then ${LICENSE} is used. 1327# specified, then ${LICENSE} is used.
1247check_license() { 1328check_license() {
1248 local lic=$1 1329 local lic=$1
1249 if [ -z "${lic}" ] ; then 1330 if [ -z "${lic}" ] ; then
1250 lic="${PORTDIR}/licenses/${LICENSE}" 1331 lic="${PORTDIR}/licenses/${LICENSE}"
1251 else 1332 else
1279 The following license outlines the terms of use of this 1360 The following license outlines the terms of use of this
1280 package. You MUST accept this license for installation to 1361 package. You MUST accept this license for installation to
1281 continue. When you are done viewing, hit 'q'. If you 1362 continue. When you are done viewing, hit 'q'. If you
1282 CTRL+C out of this, the install will not run! 1363 CTRL+C out of this, the install will not run!
1283 ********************************************************** 1364 **********************************************************
1284 1365
1285 EOF 1366 EOF
1286 cat ${lic} >> ${licmsg} 1367 cat ${lic} >> ${licmsg}
1287 ${PAGER:-less} ${licmsg} || die "Could not execute pager (${PAGER}) to accept ${lic}" 1368 ${PAGER:-less} ${licmsg} || die "Could not execute pager (${PAGER}) to accept ${lic}"
1288 einfon "Do you accept the terms of this license (${l})? [yes/no] " 1369 einfon "Do you accept the terms of this license (${l})? [yes/no] "
1289 read alic 1370 read alic
1297 die "Failed to accept license" 1378 die "Failed to accept license"
1298 ;; 1379 ;;
1299 esac 1380 esac
1300} 1381}
1301 1382
1383# @FUNCTION: cdrom_get_cds
1384# @USAGE: <file on cd1> [file on cd2] [file on cd3] [...]
1385# @DESCRIPTION:
1302# Aquire cd(s) for those lovely cd-based emerges. Yes, this violates 1386# Aquire cd(s) for those lovely cd-based emerges. Yes, this violates
1303# the whole 'non-interactive' policy, but damnit I want CD support ! 1387# the whole 'non-interactive' policy, but damnit I want CD support !
1304# 1388#
1305# with these cdrom functions we handle all the user interaction and 1389# With these cdrom functions we handle all the user interaction and
1306# standardize everything. all you have to do is call cdrom_get_cds() 1390# standardize everything. All you have to do is call cdrom_get_cds()
1307# and when the function returns, you can assume that the cd has been 1391# and when the function returns, you can assume that the cd has been
1308# found at CDROM_ROOT. 1392# found at CDROM_ROOT.
1309# 1393#
1394# The function will attempt to locate a cd based upon a file that is on
1395# the cd. The more files you give this function, the more cds
1396# the cdrom functions will handle.
1397#
1310# normally the cdrom functions will refer to the cds as 'cd #1', 'cd #2', 1398# Normally the cdrom functions will refer to the cds as 'cd #1', 'cd #2',
1311# etc... if you want to give the cds better names, then just export 1399# etc... If you want to give the cds better names, then just export
1312# the appropriate CDROM_NAME variable before calling cdrom_get_cds(). 1400# the appropriate CDROM_NAME variable before calling cdrom_get_cds().
1313# - CDROM_NAME="fooie cd" - for when you only want 1 cd 1401# Use CDROM_NAME for one cd, or CDROM_NAME_# for multiple cds. You can
1314# - CDROM_NAME_1="install cd" - for when you want more than 1 cd 1402# also use the CDROM_NAME_SET bash array.
1315# CDROM_NAME_2="data cd"
1316# - CDROM_NAME_SET=( "install cd" "data cd" ) - short hand for CDROM_NAME_#
1317# 1403#
1318# for those multi cd ebuilds, see the cdrom_load_next_cd() below. 1404# For those multi cd ebuilds, see the cdrom_load_next_cd() function.
1319#
1320# Usage: cdrom_get_cds <file on cd1> [file on cd2] [file on cd3] [...]
1321# - this will attempt to locate a cd based upon a file that is on
1322# the cd ... the more files you give this function, the more cds
1323# the cdrom functions will handle
1324cdrom_get_cds() { 1405cdrom_get_cds() {
1325 # first we figure out how many cds we're dealing with by 1406 # first we figure out how many cds we're dealing with by
1326 # the # of files they gave us 1407 # the # of files they gave us
1327 local cdcnt=0 1408 local cdcnt=0
1328 local f= 1409 local f=
1414 export CDROM_SET="" 1495 export CDROM_SET=""
1415 export CDROM_CURRENT_CD=0 1496 export CDROM_CURRENT_CD=0
1416 cdrom_load_next_cd 1497 cdrom_load_next_cd
1417} 1498}
1418 1499
1419# this is only used when you need access to more than one cd. 1500# @FUNCTION: cdrom_load_next_cd
1420# when you have finished using the first cd, just call this function. 1501# @DESCRIPTION:
1421# when it returns, CDROM_ROOT will be pointing to the second cd. 1502# Some packages are so big they come on multiple CDs. When you're done reading
1422# remember, you can only go forward in the cd chain, you can't go back. 1503# files off a CD and want access to the next one, just call this function.
1504# Again, all the messy details of user interaction are taken care of for you.
1505# Once this returns, just read the variable CDROM_ROOT for the location of the
1506# mounted CD. Note that you can only go forward in the CD list, so make sure
1507# you only call this function when you're done using the current CD.
1423cdrom_load_next_cd() { 1508cdrom_load_next_cd() {
1424 local var 1509 local var
1425 ((++CDROM_CURRENT_CD)) 1510 ((++CDROM_CURRENT_CD))
1426 1511
1427 unset CDROM_ROOT 1512 unset CDROM_ROOT
1444# displayed and we'll hang out here until: 1529# displayed and we'll hang out here until:
1445# (1) the file is found on a mounted cdrom 1530# (1) the file is found on a mounted cdrom
1446# (2) the user hits CTRL+C 1531# (2) the user hits CTRL+C
1447_cdrom_locate_file_on_cd() { 1532_cdrom_locate_file_on_cd() {
1448 local mline="" 1533 local mline=""
1449 local showedmsg=0 1534 local showedmsg=0 showjolietmsg=0
1450 1535
1451 while [[ -z ${CDROM_ROOT} ]] ; do 1536 while [[ -z ${CDROM_ROOT} ]] ; do
1452 local i=0 1537 local i=0
1453 local -a cdset=(${*//:/ }) 1538 local -a cdset=(${*//:/ })
1454 if [[ -n ${CDROM_SET} ]] ; then 1539 if [[ -n ${CDROM_SET} ]] ; then
1459 local dir=$(dirname ${cdset[${i}]}) 1544 local dir=$(dirname ${cdset[${i}]})
1460 local file=$(basename ${cdset[${i}]}) 1545 local file=$(basename ${cdset[${i}]})
1461 1546
1462 local point= node= fs= foo= 1547 local point= node= fs= foo=
1463 while read point node fs foo ; do 1548 while read point node fs foo ; do
1464 [[ " cd9660 iso9660 " != *" ${fs} "* ]] && \ 1549 [[ " cd9660 iso9660 udf " != *" ${fs} "* ]] && \
1465 ! [[ ${fs} == "subfs" && ",${opts}," == *",fs=cdfss,"* ]] \ 1550 ! [[ ${fs} == "subfs" && ",${opts}," == *",fs=cdfss,"* ]] \
1466 && continue 1551 && continue
1467 point=${point//\040/ } 1552 point=${point//\040/ }
1553 [[ ! -d ${point}/${dir} ]] && continue
1468 [[ -z $(find "${point}/${dir}" -maxdepth 1 -iname "${file}") ]] && continue 1554 [[ -z $(find "${point}/${dir}" -maxdepth 1 -iname "${file}") ]] && continue
1469 export CDROM_ROOT=${point} 1555 export CDROM_ROOT=${point}
1470 export CDROM_SET=${i} 1556 export CDROM_SET=${i}
1471 export CDROM_MATCH=${cdset[${i}]} 1557 export CDROM_MATCH=${cdset[${i}]}
1472 return 1558 return
1494 showedmsg=1 1580 showedmsg=1
1495 fi 1581 fi
1496 einfo "Press return to scan for the cd again" 1582 einfo "Press return to scan for the cd again"
1497 einfo "or hit CTRL+C to abort the emerge." 1583 einfo "or hit CTRL+C to abort the emerge."
1498 echo 1584 echo
1585 if [[ ${showjolietmsg} -eq 0 ]] ; then
1586 showjolietmsg=1
1587 else
1499 einfo "If you are having trouble with the detection" 1588 ewarn "If you are having trouble with the detection"
1500 einfo "of your CD, it is possible that you do not have" 1589 ewarn "of your CD, it is possible that you do not have"
1501 einfo "Joliet support enabled in your kernel. Please" 1590 ewarn "Joliet support enabled in your kernel. Please"
1502 einfo "check that CONFIG_JOLIET is enabled in your kernel." 1591 ewarn "check that CONFIG_JOLIET is enabled in your kernel."
1592 ebeep 5
1593 fi
1503 read || die "something is screwed with your system" 1594 read || die "something is screwed with your system"
1504 done 1595 done
1505} 1596}
1506 1597
1598# @FUNCTION: strip-linguas
1599# @USAGE: [<allow LINGUAS>|<-i|-u> <directories of .po files>]
1600# @DESCRIPTION:
1507# Make sure that LINGUAS only contains languages that 1601# Make sure that LINGUAS only contains languages that
1508# a package can support 1602# a package can support. The first form allows you to
1509# 1603# specify a list of LINGUAS. The -i builds a list of po
1510# usage: strip-linguas <allow LINGUAS> 1604# files found in all the directories and uses the
1511# strip-linguas -i <directories of .po files> 1605# intersection of the lists. The -u builds a list of po
1512# strip-linguas -u <directories of .po files> 1606# files found in all the directories and uses the union
1513# 1607# of the lists.
1514# The first form allows you to specify a list of LINGUAS.
1515# The -i builds a list of po files found in all the
1516# directories and uses the intersection of the lists.
1517# The -u builds a list of po files found in all the
1518# directories and uses the union of the lists.
1519strip-linguas() { 1608strip-linguas() {
1520 local ls newls nols 1609 local ls newls nols
1521 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then 1610 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then
1522 local op=$1; shift 1611 local op=$1; shift
1523 ls=$(find "$1" -name '*.po' -exec basename {} .po \;); shift 1612 ls=$(find "$1" -name '*.po' -exec basename {} .po ';'); shift
1524 local d f 1613 local d f
1525 for d in "$@" ; do 1614 for d in "$@" ; do
1526 if [[ ${op} == "-u" ]] ; then 1615 if [[ ${op} == "-u" ]] ; then
1527 newls=${ls} 1616 newls=${ls}
1528 else 1617 else
1529 newls="" 1618 newls=""
1530 fi 1619 fi
1531 for f in $(find "$d" -name '*.po' -exec basename {} .po \;) ; do 1620 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do
1532 if [[ ${op} == "-i" ]] ; then 1621 if [[ ${op} == "-i" ]] ; then
1533 hasq ${f} ${ls} && newls="${newls} ${f}" 1622 hasq ${f} ${ls} && newls="${newls} ${f}"
1534 else 1623 else
1535 hasq ${f} ${ls} || newls="${newls} ${f}" 1624 hasq ${f} ${ls} || newls="${newls} ${f}"
1536 fi 1625 fi
1549 else 1638 else
1550 nols="${nols} ${f}" 1639 nols="${nols} ${f}"
1551 fi 1640 fi
1552 done 1641 done
1553 [[ -n ${nols} ]] \ 1642 [[ -n ${nols} ]] \
1554 && ewarn "Sorry, but ${PN} does not support the LINGUAs:" ${nols} 1643 && ewarn "Sorry, but ${PN} does not support the LINGUAS:" ${nols}
1555 export LINGUAS=${newls:1} 1644 export LINGUAS=${newls:1}
1556} 1645}
1557 1646
1558# moved from kernel.eclass since they are generally useful outside of 1647# @FUNCTION: preserve_old_lib
1559# kernel.eclass -iggy (20041002) 1648# @USAGE: <libs to preserve> [more libs]
1560 1649# @DESCRIPTION:
1561# the following functions are useful in kernel module ebuilds, etc.
1562# for an example see ivtv or drbd ebuilds
1563
1564# set's ARCH to match what the kernel expects
1565set_arch_to_kernel() {
1566 i=10
1567 while ((i--)) ; do
1568 ewarn "PLEASE UPDATE TO YOUR PACKAGE TO USE linux-info.eclass"
1569 done
1570 export EUTILS_ECLASS_PORTAGE_ARCH="${ARCH}"
1571 case ${ARCH} in
1572 x86) export ARCH="i386";;
1573 amd64) export ARCH="x86_64";;
1574 hppa) export ARCH="parisc";;
1575 mips) export ARCH="mips";;
1576 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!
1577 *) export ARCH="${ARCH}";;
1578 esac
1579}
1580
1581# set's ARCH back to what portage expects
1582set_arch_to_portage() {
1583 i=10
1584 while ((i--)) ; do
1585 ewarn "PLEASE UPDATE TO YOUR PACKAGE TO USE linux-info.eclass"
1586 done
1587 export ARCH="${EUTILS_ECLASS_PORTAGE_ARCH}"
1588}
1589
1590# Jeremy Huddleston <eradicator@gentoo.org>:
1591# preserve_old_lib /path/to/libblah.so.0
1592# preserve_old_lib_notify /path/to/libblah.so.0
1593#
1594# These functions are useful when a lib in your package changes --library. Such 1650# These functions are useful when a lib in your package changes ABI SONAME.
1595# an example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0 1651# An example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0
1596# would break packages that link against it. Most people get around this 1652# would break packages that link against it. Most people get around this
1597# by using the portage SLOT mechanism, but that is not always a relevant 1653# by using the portage SLOT mechanism, but that is not always a relevant
1598# solution, so instead you can add the following to your ebuilds: 1654# solution, so instead you can call this from pkg_preinst. See also the
1599# 1655# preserve_old_lib_notify function.
1600# pkg_preinst() {
1601# ...
1602# preserve_old_lib /usr/$(get_libdir)/libogg.so.0
1603# ...
1604# }
1605#
1606# pkg_postinst() {
1607# ...
1608# preserve_old_lib_notify /usr/$(get_libdir)/libogg.so.0
1609# ...
1610# }
1611
1612preserve_old_lib() { 1656preserve_old_lib() {
1613 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then 1657 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then
1614 eerror "preserve_old_lib() must be called from pkg_preinst() only" 1658 eerror "preserve_old_lib() must be called from pkg_preinst() only"
1615 die "Invalid preserve_old_lib() usage" 1659 die "Invalid preserve_old_lib() usage"
1616 fi 1660 fi
1617 [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]" 1661 [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]"
1662
1663 # let portage worry about it
1664 has preserve-libs ${FEATURES} && return 0
1618 1665
1619 local lib dir 1666 local lib dir
1620 for lib in "$@" ; do 1667 for lib in "$@" ; do
1621 [[ -e ${ROOT}/${lib} ]] || continue 1668 [[ -e ${ROOT}/${lib} ]] || continue
1622 dir=${lib%/*} 1669 dir=${lib%/*}
1624 cp "${ROOT}"/${lib} "${D}"/${lib} || die "cp ${lib} failed" 1671 cp "${ROOT}"/${lib} "${D}"/${lib} || die "cp ${lib} failed"
1625 touch "${D}"/${lib} 1672 touch "${D}"/${lib}
1626 done 1673 done
1627} 1674}
1628 1675
1676# @FUNCTION: preserve_old_lib_notify
1677# @USAGE: <libs to notify> [more libs]
1678# @DESCRIPTION:
1679# Spit helpful messages about the libraries preserved by preserve_old_lib.
1629preserve_old_lib_notify() { 1680preserve_old_lib_notify() {
1630 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then 1681 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then
1631 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only" 1682 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only"
1632 die "Invalid preserve_old_lib_notify() usage" 1683 die "Invalid preserve_old_lib_notify() usage"
1633 fi 1684 fi
1685
1686 # let portage worry about it
1687 has preserve-libs ${FEATURES} && return 0
1634 1688
1635 local lib notice=0 1689 local lib notice=0
1636 for lib in "$@" ; do 1690 for lib in "$@" ; do
1637 [[ -e ${ROOT}/${lib} ]] || continue 1691 [[ -e ${ROOT}/${lib} ]] || continue
1638 if [[ ${notice} -eq 0 ]] ; then 1692 if [[ ${notice} -eq 0 ]] ; then
1644 ewarn "helper program, simply emerge the 'gentoolkit' package." 1698 ewarn "helper program, simply emerge the 'gentoolkit' package."
1645 ewarn 1699 ewarn
1646 fi 1700 fi
1647 ewarn " # revdep-rebuild --library ${lib##*/}" 1701 ewarn " # revdep-rebuild --library ${lib##*/}"
1648 done 1702 done
1703 if [[ ${notice} -eq 1 ]] ; then
1704 ewarn
1705 ewarn "Once you've finished running revdep-rebuild, it should be safe to"
1706 ewarn "delete the old libraries. Here is a copy & paste for the lazy:"
1707 for lib in "$@" ; do
1708 ewarn " # rm '${lib}'"
1709 done
1710 fi
1649} 1711}
1650 1712
1651# Hack for people to figure out if a package was built with 1713# @FUNCTION: built_with_use
1652# certain USE flags
1653#
1654# Usage: built_with_use [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags> 1714# @USAGE: [--hidden] [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags>
1655# ex: built_with_use xchat gtk2 1715# @DESCRIPTION:
1716# A temporary hack until portage properly supports DEPENDing on USE
1717# flags being enabled in packages. This will check to see if the specified
1718# DEPEND atom was built with the specified list of USE flags. The
1719# --missing option controls the behavior if called on a package that does
1720# not actually support the defined USE flags (aka listed in IUSE).
1721# The default is to abort (call die). The -a and -o flags control
1722# the requirements of the USE flags. They correspond to "and" and "or"
1723# logic. So the -a flag means all listed USE flags must be enabled
1724# while the -o flag means at least one of the listed IUSE flags must be
1725# enabled. The --hidden option is really for internal use only as it
1726# means the USE flag we're checking is hidden expanded, so it won't be found
1727# in IUSE like normal USE flags.
1656# 1728#
1657# Flags: -a all USE flags should be utilized 1729# Remember that this function isn't terribly intelligent so order of optional
1658# -o at least one USE flag should be utilized 1730# flags matter.
1659# --missing peform the specified action if the flag is not in IUSE (true/false/die)
1660# --hidden USE flag we're checking is hidden expanded so it isnt in IUSE
1661# Note: the default flag is '-a'
1662built_with_use() { 1731built_with_use() {
1663 local hidden="no" 1732 local hidden="no"
1664 if [[ $1 == "--hidden" ]] ; then 1733 if [[ $1 == "--hidden" ]] ; then
1665 hidden="yes" 1734 hidden="yes"
1666 shift 1735 shift
1695 die) die "Unable to determine what USE flags $PKG was built with";; 1764 die) die "Unable to determine what USE flags $PKG was built with";;
1696 esac 1765 esac
1697 fi 1766 fi
1698 1767
1699 if [[ ${hidden} == "no" ]] ; then 1768 if [[ ${hidden} == "no" ]] ; then
1700 local IUSE_BUILT=$(<${IUSEFILE}) 1769 local IUSE_BUILT=( $(<"${IUSEFILE}") )
1701 # Don't check USE_EXPAND #147237 1770 # Don't check USE_EXPAND #147237
1702 local expand 1771 local expand
1703 for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do 1772 for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do
1704 if [[ $1 == ${expand}_* ]] ; then 1773 if [[ $1 == ${expand}_* ]] ; then
1705 expand="" 1774 expand=""
1706 break 1775 break
1707 fi 1776 fi
1708 done 1777 done
1709 if [[ -n ${expand} ]] ; then 1778 if [[ -n ${expand} ]] ; then
1710 if ! has $1 ${IUSE_BUILT} ; then 1779 if ! has $1 ${IUSE_BUILT[@]#[-+]} ; then
1711 case ${missing_action} in 1780 case ${missing_action} in
1712 true) return 0;; 1781 true) return 0;;
1713 false) return 1;; 1782 false) return 1;;
1714 die) die "$PKG does not actually support the $1 USE flag!";; 1783 die) die "$PKG does not actually support the $1 USE flag!";;
1715 esac 1784 esac
1727 shift 1796 shift
1728 done 1797 done
1729 [[ ${opt} = "-a" ]] 1798 [[ ${opt} = "-a" ]]
1730} 1799}
1731 1800
1801# @FUNCTION: epunt_cxx
1802# @USAGE: [dir to scan]
1803# @DESCRIPTION:
1732# Many configure scripts wrongly bail when a C++ compiler 1804# Many configure scripts wrongly bail when a C++ compiler could not be
1733# could not be detected. #73450 1805# detected. If dir is not specified, then it defaults to ${S}.
1806#
1807# http://bugs.gentoo.org/73450
1734epunt_cxx() { 1808epunt_cxx() {
1735 local dir=$1 1809 local dir=$1
1736 [[ -z ${dir} ]] && dir=${S} 1810 [[ -z ${dir} ]] && dir=${S}
1737 ebegin "Removing useless C++ checks" 1811 ebegin "Removing useless C++ checks"
1738 local f 1812 local f
1739 for f in $(find ${dir} -name configure) ; do 1813 find "${dir}" -name configure | while read f ; do
1740 patch -p0 "${f}" "${PORTDIR}/eclass/ELT-patches/nocxx/nocxx.patch" > /dev/null 1814 patch --no-backup-if-mismatch -p0 "${f}" "${PORTDIR}/eclass/ELT-patches/nocxx/nocxx.patch" > /dev/null
1741 done 1815 done
1742 eend 0 1816 eend 0
1743} 1817}
1744 1818
1745# make a wrapper script ... 1819# @FUNCTION: make_wrapper
1746# NOTE: this was originally games_make_wrapper, but I noticed other places where 1820# @USAGE: <wrapper> <target> [chdir] [libpaths] [installpath]
1747# this could be used, so I have moved it here and made it not games-specific 1821# @DESCRIPTION:
1748# -- wolf31o2 1822# Create a shell wrapper script named wrapper in installpath
1749# $1 == wrapper name 1823# (defaults to the bindir) to execute target (default of wrapper) by
1750# $2 == binary to run 1824# first optionally setting LD_LIBRARY_PATH to the colon-delimited
1751# $3 == directory to chdir before running binary 1825# libpaths followed by optionally changing directory to chdir.
1752# $4 == extra LD_LIBRARY_PATH's (make it : delimited)
1753# $5 == path for wrapper
1754make_wrapper() { 1826make_wrapper() {
1755 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5 1827 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5
1756 local tmpwrapper=$(emktemp) 1828 local tmpwrapper=$(emktemp)
1757 # We don't want to quote ${bin} so that people can pass complex 1829 # We don't want to quote ${bin} so that people can pass complex
1758 # things as $bin ... "./someprog --args" 1830 # things as $bin ... "./someprog --args"
1768fi 1840fi
1769exec ${bin} "\$@" 1841exec ${bin} "\$@"
1770EOF 1842EOF
1771 chmod go+rx "${tmpwrapper}" 1843 chmod go+rx "${tmpwrapper}"
1772 if [[ -n ${path} ]] ; then 1844 if [[ -n ${path} ]] ; then
1845 (
1773 exeinto "${path}" 1846 exeinto "${path}"
1774 newexe "${tmpwrapper}" "${wrapper}" 1847 newexe "${tmpwrapper}" "${wrapper}"
1848 ) || die
1775 else 1849 else
1776 newbin "${tmpwrapper}" "${wrapper}" 1850 newbin "${tmpwrapper}" "${wrapper}" || die
1851 fi
1852}
1853
1854# @FUNCTION: prepalldocs
1855# @USAGE:
1856# @DESCRIPTION:
1857# Compress files in /usr/share/doc which are not already
1858# compressed, excluding /usr/share/doc/${PF}/html.
1859# Uses the ecompressdir to do the compression.
1860# 2009-02-18 by betelgeuse:
1861# Commented because ecompressdir is even more internal to
1862# Portage than prepalldocs (it's not even mentioned in man 5
1863# ebuild). Please submit a better version for review to gentoo-dev
1864# if you want prepalldocs here.
1865#prepalldocs() {
1866# if [[ -n $1 ]] ; then
1867# ewarn "prepalldocs: invalid usage; takes no arguments"
1777 fi 1868# fi
1778} 1869
1870# cd "${D}"
1871# [[ -d usr/share/doc ]] || return 0
1872
1873# find usr/share/doc -exec gzip {} +
1874# ecompressdir --ignore /usr/share/doc/${PF}/html
1875# ecompressdir --queue /usr/share/doc
1876#}

Legend:
Removed from v.1.279  
changed lines
  Added in v.1.321

  ViewVC Help
Powered by ViewVC 1.1.20