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

Diff of /eclass/eutils.eclass

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

Revision 1.282 Revision 1.324
1# Copyright 1999-2007 Gentoo Foundation 1# Copyright 1999-2009 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.282 2007/06/16 07:11:43 vapier Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.324 2010/01/03 19:57:10 zmedico 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
52# @FUNCTION: ecvs_clean
53# @USAGE: [list of dirs]
54# @DESCRIPTION:
55# Remove CVS directories recursiveley. Useful when a source tarball contains
56# internal CVS directories. Defaults to $PWD.
57ecvs_clean() {
58 [[ -z $* ]] && set -- .
59 find "$@" -type d -name 'CVS' -prune -print0 | xargs -0 rm -rf
60 find "$@" -type f -name '.cvs*' -print0 | xargs -0 rm -rf
61}
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}
72
73# @FUNCTION: eshopts_push
74# @USAGE: [options to `set`]
75# @DESCRIPTION:
76# Often times code will want to enable a shell option to change code behavior.
77# Since changing shell options can easily break other pieces of code (which
78# assume the default state), eshopts_push is used to (1) push the current shell
79# options onto a stack and (2) pass the specified arguments to set.
80#
81# A common example is to disable shell globbing so that special meaning/care
82# may be used with variables/arguments to custom functions. That would be:
83# @CODE
84# eshopts_push -o noglob
85# for x in ${foo} ; do
86# if ...some check... ; then
87# eshopts_pop
88# return 0
89# fi
90# done
91# eshopts_pop
92# @CODE
93eshopts_push() {
94 # have to assume __ESHOPTS_SAVE__ isn't screwed with
95 # as a `declare -a` here will reset its value
96 local i=${#__ESHOPTS_SAVE__[@]}
97 __ESHOPTS_SAVE__[$i]=$-
98 [[ $# -eq 0 ]] && return 0
99 set "$@" || die "eshopts_push: bad options to set: $*"
100}
101
102# @FUNCTION: eshopts_pop
103# @USAGE:
104# @DESCRIPTION:
105# Restore the shell options to the state saved with the corresponding
106# eshopts_push call. See that function for more details.
107eshopts_pop() {
108 [[ $# -ne 0 ]] && die "eshopts_pop takes no arguments"
109 local i=$(( ${#__ESHOPTS_SAVE__[@]} - 1 ))
110 [[ ${i} -eq -1 ]] && die "eshopts_{push,pop}: unbalanced pair"
111 local s=${__ESHOPTS_SAVE__[$i]}
112 unset __ESHOPTS_SAVE__[$i]
113 set +$- || die "eshopts_pop: sanity: invalid shell settings: $-"
114 set -${s} || die "eshopts_pop: sanity: unable to restore saved shell settings: ${s}"
115}
116
41# Default directory where patches are located 117# Default directory where patches are located
42EPATCH_SOURCE="${WORKDIR}/patch" 118EPATCH_SOURCE="${WORKDIR}/patch"
43# Default extension for patches 119# Default extension for patches
44EPATCH_SUFFIX="patch.bz2" 120EPATCH_SUFFIX="patch.bz2"
45# Default options for patch 121# Default options for patch
46# Set -g0 to keep RCS, ClearCase, Perforce and SCCS happy. Bug #24571 122# Set -g0 to keep RCS, ClearCase, Perforce and SCCS happy. Bug #24571
47# Set --no-backup-if-mismatch so we don't leave '.orig' files behind. 123# Set --no-backup-if-mismatch so we don't leave '.orig' files behind.
48# Set -E to automatically remove empty files. 124# Set -E to automatically remove empty files.
49EPATCH_OPTS="-g0 -E --no-backup-if-mismatch" 125EPATCH_OPTS="-g0 -E --no-backup-if-mismatch"
50# List of patches not to apply. Not this is only file names, 126# List of patches not to apply. Note this is only file names,
51# and not the full path .. 127# and not the full path ..
52EPATCH_EXCLUDE="" 128EPATCH_EXCLUDE=""
53# Change the printed message for a single patch. 129# Change the printed message for a single patch.
54EPATCH_SINGLE_MSG="" 130EPATCH_SINGLE_MSG=""
55# Change the printed message for multiple patches. 131# Change the printed message for multiple patches.
73# bug they should be left as is to ensure an ebuild can rely on 149# bug they should be left as is to ensure an ebuild can rely on
74# them for. 150# them for.
75# 151#
76# Patches are applied in current directory. 152# Patches are applied in current directory.
77# 153#
78# Bulk Patches should preferibly have the form of: 154# Bulk Patches should preferably have the form of:
79# 155#
80# ??_${ARCH}_foo.${EPATCH_SUFFIX} 156# ??_${ARCH}_foo.${EPATCH_SUFFIX}
81# 157#
82# For example: 158# For example:
83# 159#
132 local EPATCH_SOURCE="$1/*" 208 local EPATCH_SOURCE="$1/*"
133 else 209 else
134 local EPATCH_SOURCE="$1/*.${EPATCH_SUFFIX}" 210 local EPATCH_SOURCE="$1/*.${EPATCH_SUFFIX}"
135 fi 211 fi
136 else 212 else
137 if [ ! -d ${EPATCH_SOURCE} ] || [ -n "$1" ] 213 if [[ ! -d ${EPATCH_SOURCE} ]] || [[ -n $1 ]] ; then
138 then
139 if [ -n "$1" -a "${EPATCH_SOURCE}" = "${WORKDIR}/patch" ] 214 if [ -n "$1" -a "${EPATCH_SOURCE}" = "${WORKDIR}/patch" ]
140 then 215 then
141 EPATCH_SOURCE="$1" 216 EPATCH_SOURCE="$1"
142 fi 217 fi
143 218
152 227
153 local EPATCH_SOURCE="${EPATCH_SOURCE}/*.${EPATCH_SUFFIX}" 228 local EPATCH_SOURCE="${EPATCH_SOURCE}/*.${EPATCH_SUFFIX}"
154 fi 229 fi
155 230
156 case ${EPATCH_SUFFIX##*\.} in 231 case ${EPATCH_SUFFIX##*\.} in
232 xz)
233 PIPE_CMD="xz -dc"
234 PATCH_SUFFIX="xz"
235 ;;
236 lzma)
237 PIPE_CMD="lzma -dc"
238 PATCH_SUFFIX="lzma"
239 ;;
157 bz2) 240 bz2)
158 PIPE_CMD="bzip2 -dc" 241 PIPE_CMD="bzip2 -dc"
159 PATCH_SUFFIX="bz2" 242 PATCH_SUFFIX="bz2"
160 ;; 243 ;;
161 gz|Z|z) 244 gz|Z|z)
211 fi 294 fi
212 295
213 echo "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 296 echo "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
214 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 297 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
215 298
299 # Decompress the patch if need be
300 if [[ ${PATCH_SUFFIX} != "patch" ]] ; then
301 echo -n "PIPE_COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
302 echo "${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
303
304 if ! (${PIPE_CMD} ${x} > ${PATCH_TARGET}) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1 ; then
305 echo
306 eerror "Could not extract patch!"
307 #die "Could not extract patch!"
308 count=5
309 break
310 fi
311 else
312 PATCH_TARGET="${x}"
313 fi
314
315 # Check for absolute paths in patches. If sandbox is disabled,
316 # people could (accidently) patch files in the root filesystem.
317 # Or trigger other unpleasantries #237667. So disallow -p0 on
318 # such patches.
319 local abs_paths=$(egrep -n '^[-+]{3} /' "${PATCH_TARGET}" | awk '$2 != "/dev/null" { print }')
320 if [[ -n ${abs_paths} ]] ; then
321 count=1
322 echo "NOTE: skipping -p0 due to absolute paths in patch:" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
323 echo "${abs_paths}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
324 fi
325
216 # Allow for prefix to differ ... im lazy, so shoot me :/ 326 # Allow for prefix to differ ... im lazy, so shoot me :/
217 while [ "${count}" -lt 5 ] 327 while [ "${count}" -lt 5 ]
218 do 328 do
219 # Generate some useful debug info ... 329 # Generate some useful debug info ...
220 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 330 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
221 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 331 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
222 332
223 if [ "${PATCH_SUFFIX}" != "patch" ]
224 then
225 echo -n "PIPE_COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
226 echo "${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
227 else
228 PATCH_TARGET="${x}"
229 fi
230
231 echo -n "PATCH COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 333 echo -n "PATCH COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
232 echo "patch -p${count} ${popts} < ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 334 echo "patch -p${count} ${popts} < ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
233 335
234 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 336 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
235 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 337 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
236
237 if [ "${PATCH_SUFFIX}" != "patch" ]
238 then
239 if ! (${PIPE_CMD} ${x} > ${PATCH_TARGET}) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1
240 then
241 echo
242 eerror "Could not extract patch!"
243 #die "Could not extract patch!"
244 count=5
245 break
246 fi
247 fi
248 338
249 if (cat ${PATCH_TARGET} | patch -p${count} ${popts} --dry-run -f ; _epatch_assert) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1 339 if (cat ${PATCH_TARGET} | patch -p${count} ${popts} --dry-run -f ; _epatch_assert) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1
250 then 340 then
251 _epatch_draw_line "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real 341 _epatch_draw_line "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
252 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real 342 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
301 if [ "${SINGLE_PATCH}" = "no" ] 391 if [ "${SINGLE_PATCH}" = "no" ]
302 then 392 then
303 einfo "Done with patching" 393 einfo "Done with patching"
304 fi 394 fi
305} 395}
396epatch_user() {
397 [[ $# -ne 0 ]] && die "epatch_user takes no options"
306 398
399 # don't clobber any EPATCH vars that the parent might want
400 local EPATCH_SOURCE check base=${PORTAGE_CONFIGROOT%/}/etc/portage/patches
401 for check in {${CATEGORY}/${PF},${CATEGORY}/${P},${CATEGORY}/${PN}}; do
402 EPATCH_SOURCE=${base}/${CTARGET}/${check}
403 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${CHOST}/${check}
404 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${check}
405 if [[ -d ${EPATCH_SOURCE} ]] ; then
406 EPATCH_SOURCE=${EPATCH_SOURCE} \
407 EPATCH_SUFFIX="patch" \
408 EPATCH_FORCE="yes" \
409 EPATCH_MULTI_MSG="Applying user patches from ${EPATCH_SOURCE} ..." \
410 epatch
411 break
412 fi
413 done
414}
415
416# @FUNCTION: emktemp
417# @USAGE: [temp dir]
418# @DESCRIPTION:
307# Cheap replacement for when debianutils (and thus mktemp) 419# Cheap replacement for when debianutils (and thus mktemp)
308# does not exist on the users system 420# does not exist on the users system.
309# vapier@gentoo.org
310#
311# Takes just 1 optional parameter (the directory to create tmpfile in)
312emktemp() { 421emktemp() {
313 local exe="touch" 422 local exe="touch"
314 [[ $1 == -d ]] && exe="mkdir" && shift 423 [[ $1 == -d ]] && exe="mkdir" && shift
315 local topdir=$1 424 local topdir=$1
316 425
337 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX 446 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX
338 fi 447 fi
339 fi 448 fi
340} 449}
341 450
451# @FUNCTION: egetent
452# @USAGE: <database> <key>
453# @MAINTAINER:
454# base-system@gentoo.org (Linux)
455# Joe Jezak <josejx@gmail.com> (OS X)
456# usata@gentoo.org (OS X)
457# Aaron Walker <ka0ttic@gentoo.org> (FreeBSD)
458# @DESCRIPTION:
342# Small wrapper for getent (Linux), nidump (Mac OS X), 459# Small wrapper for getent (Linux),
460# nidump (< Mac OS X 10.5), dscl (Mac OS X 10.5),
343# and pw (FreeBSD) used in enewuser()/enewgroup() 461# and pw (FreeBSD) used in enewuser()/enewgroup()
344# Joe Jezak <josejx@gmail.com> and usata@gentoo.org
345# FBSD stuff: Aaron Walker <ka0ttic@gentoo.org>
346#
347# egetent(database, key)
348egetent() { 462egetent() {
349 case ${CHOST} in 463 case ${CHOST} in
350 *-darwin*) 464 *-darwin[678])
351 case "$2" in 465 case "$2" in
352 *[!0-9]*) # Non numeric 466 *[!0-9]*) # Non numeric
353 nidump $1 . | awk -F":" "{ if (\$1 ~ /^$2$/) {print \$0;exit;} }" 467 nidump $1 . | awk -F":" "{ if (\$1 ~ /^$2$/) {print \$0;exit;} }"
354 ;; 468 ;;
355 *) # Numeric 469 *) # Numeric
356 nidump $1 . | awk -F":" "{ if (\$3 == $2) {print \$0;exit;} }" 470 nidump $1 . | awk -F":" "{ if (\$3 == $2) {print \$0;exit;} }"
471 ;;
472 esac
473 ;;
474 *-darwin*)
475 local mytype=$1
476 [[ "passwd" == $mytype ]] && mytype="Users"
477 [[ "group" == $mytype ]] && mytype="Groups"
478 case "$2" in
479 *[!0-9]*) # Non numeric
480 dscl . -read /$mytype/$2 2>/dev/null |grep RecordName
481 ;;
482 *) # Numeric
483 local mykey="UniqueID"
484 [[ $mytype == "Groups" ]] && mykey="PrimaryGroupID"
485 dscl . -search /$mytype $mykey $2 2>/dev/null
357 ;; 486 ;;
358 esac 487 esac
359 ;; 488 ;;
360 *-freebsd*|*-dragonfly*) 489 *-freebsd*|*-dragonfly*)
361 local opts action="user" 490 local opts action="user"
376 getent "$1" "$2" 505 getent "$1" "$2"
377 ;; 506 ;;
378 esac 507 esac
379} 508}
380 509
381# Simplify/standardize adding users to the system 510# @FUNCTION: enewuser
382# vapier@gentoo.org 511# @USAGE: <user> [uid] [shell] [homedir] [groups] [params]
383# 512# @DESCRIPTION:
384# enewuser(username, uid, shell, homedir, groups, extra options) 513# Same as enewgroup, you are not required to understand how to properly add
385# 514# a user to the system. The only required parameter is the username.
386# Default values if you do not specify any: 515# Default uid is (pass -1 for this) next available, default shell is
387# username: REQUIRED ! 516# /bin/false, default homedir is /dev/null, there are no default groups,
388# uid: next available (see useradd(8)) 517# and default params sets the comment as 'added by portage for ${PN}'.
389# note: pass -1 to get default behavior
390# shell: /bin/false
391# homedir: /dev/null
392# groups: none
393# extra: comment of 'added by portage for ${PN}'
394enewuser() { 518enewuser() {
395 case ${EBUILD_PHASE} in 519 case ${EBUILD_PHASE} in
396 unpack|compile|test|install) 520 unpack|compile|test|install)
397 eerror "'enewuser()' called from '${EBUILD_PHASE}()' which is not a pkg_* function." 521 eerror "'enewuser()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
398 eerror "Package fails at QA and at life. Please file a bug." 522 eerror "Package fails at QA and at life. Please file a bug."
566 fi 690 fi
567 ;; 691 ;;
568 692
569 *) 693 *)
570 if [[ -z $@ ]] ; then 694 if [[ -z $@ ]] ; then
571 useradd ${opts} ${euser} \ 695 useradd ${opts} \
572 -c "added by portage for ${PN}" \ 696 -c "added by portage for ${PN}" \
697 ${euser} \
573 || die "enewuser failed" 698 || die "enewuser failed"
574 else 699 else
575 einfo " - Extra: $@" 700 einfo " - Extra: $@"
576 useradd ${opts} ${euser} "$@" \ 701 useradd ${opts} "$@" \
702 ${euser} \
577 || die "enewuser failed" 703 || die "enewuser failed"
578 fi 704 fi
579 ;; 705 ;;
580 esac 706 esac
581 707
587 fi 713 fi
588 714
589 export SANDBOX_ON=${oldsandbox} 715 export SANDBOX_ON=${oldsandbox}
590} 716}
591 717
592# Simplify/standardize adding groups to the system 718# @FUNCTION: enewgroup
593# vapier@gentoo.org 719# @USAGE: <group> [gid]
594# 720# @DESCRIPTION:
595# enewgroup(group, gid) 721# This function does not require you to understand how to properly add a
596# 722# group to the system. Just give it a group name to add and enewgroup will
597# Default values if you do not specify any: 723# do the rest. You may specify the gid for the group or allow the group to
598# groupname: REQUIRED ! 724# allocate the next available one.
599# gid: next available (see groupadd(8))
600# extra: none
601enewgroup() { 725enewgroup() {
602 case ${EBUILD_PHASE} in 726 case ${EBUILD_PHASE} in
603 unpack|compile|test|install) 727 unpack|compile|test|install)
604 eerror "'enewgroup()' called from '${EBUILD_PHASE}()' which is not a pkg_* function." 728 eerror "'enewgroup()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
605 eerror "Package fails at QA and at life. Please file a bug." 729 eerror "Package fails at QA and at life. Please file a bug."
701 ;; 825 ;;
702 esac 826 esac
703 export SANDBOX_ON="${oldsandbox}" 827 export SANDBOX_ON="${oldsandbox}"
704} 828}
705 829
706# Simple script to replace 'dos2unix' binaries 830# @FUNCTION: edos2unix
707# vapier@gentoo.org 831# @USAGE: <file> [more files ...]
708# 832# @DESCRIPTION:
709# edos2unix(file, <more files> ...) 833# A handy replacement for dos2unix, recode, fixdos, etc... This allows you
834# to remove all of these text utilities from DEPEND variables because this
835# is a script based solution. Just give it a list of files to convert and
836# they will all be changed from the DOS CRLF format to the UNIX LF format.
710edos2unix() { 837edos2unix() {
711 echo "$@" | xargs sed -i 's/\r$//' 838 echo "$@" | xargs sed -i 's/\r$//'
712} 839}
713
714
715##############################################################
716# START: Handle .desktop files and menu entries #
717# maybe this should be separated into a new eclass some time #
718# lanius@gentoo.org #
719##############################################################
720 840
721# Make a desktop file ! 841# Make a desktop file !
722# Great for making those icons in kde/gnome startmenu ! 842# Great for making those icons in kde/gnome startmenu !
723# Amaze your friends ! Get the women ! Join today ! 843# Amaze your friends ! Get the women ! Join today !
724# 844#
728# name: the name that will show up in the menu 848# name: the name that will show up in the menu
729# icon: give your little like a pretty little icon ... 849# icon: give your little like a pretty little icon ...
730# this can be relative (to /usr/share/pixmaps) or 850# this can be relative (to /usr/share/pixmaps) or
731# a full path to an icon 851# a full path to an icon
732# type: what kind of application is this ? for categories: 852# type: what kind of application is this ? for categories:
733# http://www.freedesktop.org/Standards/desktop-entry-spec 853# http://standards.freedesktop.org/menu-spec/latest/apa.html
734# path: if your app needs to startup in a specific dir 854# path: if your app needs to startup in a specific dir
735make_desktop_entry() { 855make_desktop_entry() {
736 [[ -z $1 ]] && eerror "make_desktop_entry: You must specify the executable" && return 1 856 [[ -z $1 ]] && eerror "make_desktop_entry: You must specify the executable" && return 1
737 857
738 local exec=${1} 858 local exec=${1}
739 local name=${2:-${PN}} 859 local name=${2:-${PN}}
740 local icon=${3:-${PN}.png} 860 local icon=${3:-${PN}}
741 local type=${4} 861 local type=${4}
742 local path=${5} 862 local path=${5}
743 863
744 if [[ -z ${type} ]] ; then 864 if [[ -z ${type} ]] ; then
745 local catmaj=${CATEGORY%%-*} 865 local catmaj=${CATEGORY%%-*}
746 local catmin=${CATEGORY##*-} 866 local catmin=${CATEGORY##*-}
747 case ${catmaj} in 867 case ${catmaj} in
748 app) 868 app)
749 case ${catmin} in 869 case ${catmin} in
870 accessibility) type=Accessibility;;
750 admin) type=System;; 871 admin) type=System;;
872 antivirus) type=System;;
873 arch) type=Archiving;;
874 backup) type=Archiving;;
751 cdr) type=DiscBurning;; 875 cdr) type=DiscBurning;;
752 dicts) type=Dictionary;; 876 dicts) type=Dictionary;;
877 doc) type=Documentation;;
753 editors) type=TextEditor;; 878 editors) type=TextEditor;;
754 emacs) type=TextEditor;; 879 emacs) type=TextEditor;;
755 emulation) type=Emulator;; 880 emulation) type=Emulator;;
756 laptop) type=HardwareSettings;; 881 laptop) type=HardwareSettings;;
757 office) type=Office;; 882 office) type=Office;;
883 pda) type=PDA;;
758 vim) type=TextEditor;; 884 vim) type=TextEditor;;
759 xemacs) type=TextEditor;; 885 xemacs) type=TextEditor;;
760 *) type=;; 886 *) type=;;
761 esac 887 esac
762 ;; 888 ;;
768 games) 894 games)
769 case ${catmin} in 895 case ${catmin} in
770 action|fps) type=ActionGame;; 896 action|fps) type=ActionGame;;
771 arcade) type=ArcadeGame;; 897 arcade) type=ArcadeGame;;
772 board) type=BoardGame;; 898 board) type=BoardGame;;
899 emulation) type=Emulator;;
773 kids) type=KidsGame;; 900 kids) type=KidsGame;;
774 emulation) type=Emulator;;
775 puzzle) type=LogicGame;; 901 puzzle) type=LogicGame;;
902 roguelike) type=RolePlaying;;
776 rpg) type=RolePlaying;; 903 rpg) type=RolePlaying;;
777 roguelike) type=RolePlaying;;
778 simulation) type=Simulation;; 904 simulation) type=Simulation;;
779 sports) type=SportsGame;; 905 sports) type=SportsGame;;
780 strategy) type=StrategyGame;; 906 strategy) type=StrategyGame;;
781 *) type=;; 907 *) type=;;
782 esac 908 esac
783 type="Game;${type}" 909 type="Game;${type}"
910 ;;
911
912 gnome)
913 type="Gnome;GTK"
914 ;;
915
916 kde)
917 type="KDE;Qt"
784 ;; 918 ;;
785 919
786 mail) 920 mail)
787 type="Network;Email" 921 type="Network;Email"
788 ;; 922 ;;
814 type="Network;${type}" 948 type="Network;${type}"
815 ;; 949 ;;
816 950
817 sci) 951 sci)
818 case ${catmin} in 952 case ${catmin} in
819 astro*) type=Astronomy;; 953 astro*) type=Astronomy;;
820 bio*) type=Biology;; 954 bio*) type=Biology;;
821 calc*) type=Calculator;; 955 calc*) type=Calculator;;
822 chem*) type=Chemistry;; 956 chem*) type=Chemistry;;
957 elec*) type=Electronics;;
823 geo*) type=Geology;; 958 geo*) type=Geology;;
824 math*) type=Math;; 959 math*) type=Math;;
960 physics) type=Physics;;
961 visual*) type=DataVisualization;;
825 *) type=;; 962 *) type=;;
826 esac 963 esac
827 type="Science;${type}" 964 type="Science;${type}"
965 ;;
966
967 sys)
968 type="System"
828 ;; 969 ;;
829 970
830 www) 971 www)
831 case ${catmin} in 972 case ${catmin} in
832 client) type=WebBrowser;; 973 client) type=WebBrowser;;
848 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop" 989 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop"
849 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop 990 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop
850 991
851 cat <<-EOF > "${desktop}" 992 cat <<-EOF > "${desktop}"
852 [Desktop Entry] 993 [Desktop Entry]
853 Encoding=UTF-8
854 Version=0.9.2
855 Name=${name} 994 Name=${name}
856 Type=Application 995 Type=Application
857 Comment=${DESCRIPTION} 996 Comment=${DESCRIPTION}
858 Exec=${exec} 997 Exec=${exec}
859 TryExec=${exec%% *} 998 TryExec=${exec%% *}
860 Path=${path}
861 Icon=${icon} 999 Icon=${icon}
862 Categories=Application;${type}; 1000 Categories=${type};
863 EOF 1001 EOF
1002
1003 [[ ${path} ]] && echo "Path=${path}" >> "${desktop}"
864 1004
865 ( 1005 (
866 # wrap the env here so that the 'insinto' call 1006 # wrap the env here so that the 'insinto' call
867 # doesn't corrupt the env of the caller 1007 # doesn't corrupt the env of the caller
868 insinto /usr/share/applications 1008 insinto /usr/share/applications
869 doins "${desktop}" 1009 doins "${desktop}"
870 ) 1010 )
871} 1011}
872 1012
873 1013# @FUNCTION: validate_desktop_entries
1014# @USAGE: [directories]
1015# @MAINTAINER:
1016# Carsten Lohrke <carlo@gentoo.org>
1017# @DESCRIPTION:
874# Validate desktop entries using desktop-file-utils 1018# Validate desktop entries using desktop-file-utils
875# Carsten Lohrke <carlo@gentoo.org>
876#
877# Usage: validate_desktop_entries [directory ...]
878
879validate_desktop_entries() { 1019validate_desktop_entries() {
880 if [[ -x /usr/bin/desktop-file-validate ]] ; then 1020 if [[ -x /usr/bin/desktop-file-validate ]] ; then
881 einfo "Checking desktop entry validity" 1021 einfo "Checking desktop entry validity"
882 local directories="" 1022 local directories=""
883 for d in /usr/share/applications $@ ; do 1023 for d in /usr/share/applications $@ ; do
896 else 1036 else
897 einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo." 1037 einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo."
898 fi 1038 fi
899} 1039}
900 1040
901 1041# @FUNCTION: make_session_desktop
902# Make a GDM/KDM Session file 1042# @USAGE: <title> <command> [command args...]
1043# @DESCRIPTION:
1044# Make a GDM/KDM Session file. The title is the file to execute to start the
1045# Window Manager. The command is the name of the Window Manager.
903# 1046#
904# make_session_desktop(<title>, <command>) 1047# You can set the name of the file via the ${wm} variable.
905# title: File to execute to start the Window Manager
906# command: Name of the Window Manager
907
908make_session_desktop() { 1048make_session_desktop() {
909 [[ -z $1 ]] && eerror "make_session_desktop: You must specify the title" && return 1 1049 [[ -z $1 ]] && eerror "$0: You must specify the title" && return 1
910 [[ -z $2 ]] && eerror "make_session_desktop: You must specify the command" && return 1 1050 [[ -z $2 ]] && eerror "$0: You must specify the command" && return 1
911 1051
912 local title=$1 1052 local title=$1
913 local command=$2 1053 local command=$2
914 local desktop=${T}/${wm}.desktop 1054 local desktop=${T}/${wm:-${PN}}.desktop
1055 shift 2
915 1056
916 cat <<-EOF > "${desktop}" 1057 cat <<-EOF > "${desktop}"
917 [Desktop Entry] 1058 [Desktop Entry]
918 Encoding=UTF-8
919 Name=${title} 1059 Name=${title}
920 Comment=This session logs you into ${title} 1060 Comment=This session logs you into ${title}
921 Exec=${command} 1061 Exec=${command} $*
922 TryExec=${command} 1062 TryExec=${command}
923 Type=Application 1063 Type=XSession
924 EOF 1064 EOF
925 1065
926 ( 1066 (
927 # wrap the env here so that the 'insinto' call 1067 # wrap the env here so that the 'insinto' call
928 # doesn't corrupt the env of the caller 1068 # doesn't corrupt the env of the caller
929 insinto /usr/share/xsessions 1069 insinto /usr/share/xsessions
930 doins "${desktop}" 1070 doins "${desktop}"
931 ) 1071 )
932} 1072}
933 1073
1074# @FUNCTION: domenu
1075# @USAGE: <menus>
1076# @DESCRIPTION:
1077# Install the list of .desktop menu files into the appropriate directory
1078# (/usr/share/applications).
934domenu() { 1079domenu() {
935 ( 1080 (
936 # wrap the env here so that the 'insinto' call 1081 # wrap the env here so that the 'insinto' call
937 # doesn't corrupt the env of the caller 1082 # doesn't corrupt the env of the caller
938 local i j ret=0 1083 local i j ret=0
944 elif [[ -d ${i} ]] ; then 1089 elif [[ -d ${i} ]] ; then
945 for j in "${i}"/*.desktop ; do 1090 for j in "${i}"/*.desktop ; do
946 doins "${j}" 1091 doins "${j}"
947 ((ret+=$?)) 1092 ((ret+=$?))
948 done 1093 done
1094 else
1095 ((++ret))
949 fi 1096 fi
950 done 1097 done
951 exit ${ret} 1098 exit ${ret}
952 ) 1099 )
953} 1100}
1101
1102# @FUNCTION: newmenu
1103# @USAGE: <menu> <newname>
1104# @DESCRIPTION:
1105# Like all other new* functions, install the specified menu as newname.
954newmenu() { 1106newmenu() {
955 ( 1107 (
956 # wrap the env here so that the 'insinto' call 1108 # wrap the env here so that the 'insinto' call
957 # doesn't corrupt the env of the caller 1109 # doesn't corrupt the env of the caller
958 insinto /usr/share/applications 1110 insinto /usr/share/applications
959 newins "$@" 1111 newins "$@"
960 ) 1112 )
961} 1113}
962 1114
1115# @FUNCTION: doicon
1116# @USAGE: <list of icons>
1117# @DESCRIPTION:
1118# Install the list of icons into the icon directory (/usr/share/pixmaps).
1119# This is useful in conjunction with creating desktop/menu files.
963doicon() { 1120doicon() {
964 ( 1121 (
965 # wrap the env here so that the 'insinto' call 1122 # wrap the env here so that the 'insinto' call
966 # doesn't corrupt the env of the caller 1123 # doesn't corrupt the env of the caller
967 local i j ret 1124 local i j ret
973 elif [[ -d ${i} ]] ; then 1130 elif [[ -d ${i} ]] ; then
974 for j in "${i}"/*.png ; do 1131 for j in "${i}"/*.png ; do
975 doins "${j}" 1132 doins "${j}"
976 ((ret+=$?)) 1133 ((ret+=$?))
977 done 1134 done
1135 else
1136 ((++ret))
978 fi 1137 fi
979 done 1138 done
980 exit ${ret} 1139 exit ${ret}
981 ) 1140 )
982} 1141}
1142
1143# @FUNCTION: newicon
1144# @USAGE: <icon> <newname>
1145# @DESCRIPTION:
1146# Like all other new* functions, install the specified icon as newname.
983newicon() { 1147newicon() {
984 ( 1148 (
985 # wrap the env here so that the 'insinto' call 1149 # wrap the env here so that the 'insinto' call
986 # doesn't corrupt the env of the caller 1150 # doesn't corrupt the env of the caller
987 insinto /usr/share/pixmaps 1151 insinto /usr/share/pixmaps
988 newins "$@" 1152 newins "$@"
989 ) 1153 )
990} 1154}
991
992##############################################################
993# END: Handle .desktop files and menu entries #
994##############################################################
995
996 1155
997# for internal use only (unpack_pdv and unpack_makeself) 1156# for internal use only (unpack_pdv and unpack_makeself)
998find_unpackable_file() { 1157find_unpackable_file() {
999 local src=$1 1158 local src=$1
1000 if [[ -z ${src} ]] ; then 1159 if [[ -z ${src} ]] ; then
1010 fi 1169 fi
1011 [[ ! -e ${src} ]] && return 1 1170 [[ ! -e ${src} ]] && return 1
1012 echo "${src}" 1171 echo "${src}"
1013} 1172}
1014 1173
1174# @FUNCTION: unpack_pdv
1175# @USAGE: <file to unpack> <size of off_t>
1176# @DESCRIPTION:
1015# Unpack those pesky pdv generated files ... 1177# Unpack those pesky pdv generated files ...
1016# They're self-unpacking programs with the binary package stuffed in 1178# They're self-unpacking programs with the binary package stuffed in
1017# the middle of the archive. Valve seems to use it a lot ... too bad 1179# the middle of the archive. Valve seems to use it a lot ... too bad
1018# it seems to like to segfault a lot :(. So lets take it apart ourselves. 1180# it seems to like to segfault a lot :(. So lets take it apart ourselves.
1019# 1181#
1020# Usage: unpack_pdv [file to unpack] [size of off_t]
1021# - you have to specify the off_t size ... i have no idea how to extract that 1182# You have to specify the off_t size ... I have no idea how to extract that
1022# information out of the binary executable myself. basically you pass in 1183# information out of the binary executable myself. Basically you pass in
1023# the size of the off_t type (in bytes) on the machine that built the pdv 1184# the size of the off_t type (in bytes) on the machine that built the pdv
1185# archive.
1186#
1024# archive. one way to determine this is by running the following commands: 1187# One way to determine this is by running the following commands:
1188#
1189# @CODE
1025# strings <pdv archive> | grep lseek 1190# strings <pdv archive> | grep lseek
1026# strace -elseek <pdv archive> 1191# strace -elseek <pdv archive>
1192# @CODE
1193#
1027# basically look for the first lseek command (we do the strings/grep because 1194# Basically look for the first lseek command (we do the strings/grep because
1028# sometimes the function call is _llseek or something) and steal the 2nd 1195# sometimes the function call is _llseek or something) and steal the 2nd
1029# parameter. here is an example: 1196# parameter. Here is an example:
1197#
1198# @CODE
1030# root@vapier 0 pdv_unpack # strings hldsupdatetool.bin | grep lseek 1199# vapier@vapier 0 pdv_unpack # strings hldsupdatetool.bin | grep lseek
1031# lseek 1200# lseek
1032# root@vapier 0 pdv_unpack # strace -elseek ./hldsupdatetool.bin 1201# vapier@vapier 0 pdv_unpack # strace -elseek ./hldsupdatetool.bin
1033# lseek(3, -4, SEEK_END) = 2981250 1202# lseek(3, -4, SEEK_END) = 2981250
1203# @CODE
1204#
1034# thus we would pass in the value of '4' as the second parameter. 1205# Thus we would pass in the value of '4' as the second parameter.
1035unpack_pdv() { 1206unpack_pdv() {
1036 local src=$(find_unpackable_file "$1") 1207 local src=$(find_unpackable_file "$1")
1037 local sizeoff_t=$2 1208 local sizeoff_t=$2
1038 1209
1039 [[ -z ${src} ]] && die "Could not locate source for '$1'" 1210 [[ -z ${src} ]] && die "Could not locate source for '$1'"
1101 true 1272 true
1102 #[ -s "${datafile}" ] || die "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')" 1273 #[ -s "${datafile}" ] || die "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
1103 #assert "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')" 1274 #assert "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
1104} 1275}
1105 1276
1277# @FUNCTION: unpack_makeself
1278# @USAGE: [file to unpack] [offset] [tail|dd]
1279# @DESCRIPTION:
1106# Unpack those pesky makeself generated files ... 1280# Unpack those pesky makeself generated files ...
1107# They're shell scripts with the binary package tagged onto 1281# They're shell scripts with the binary package tagged onto
1108# the end of the archive. Loki utilized the format as does 1282# the end of the archive. Loki utilized the format as does
1109# many other game companies. 1283# many other game companies.
1110# 1284#
1111# Usage: unpack_makeself [file to unpack] [offset] [tail|dd] 1285# If the file is not specified, then ${A} is used. If the
1112# - If the file is not specified then unpack will utilize ${A}.
1113# - If the offset is not specified then we will attempt to extract 1286# offset is not specified then we will attempt to extract
1114# the proper offset from the script itself. 1287# the proper offset from the script itself.
1115unpack_makeself() { 1288unpack_makeself() {
1116 local src_input=${1:-${A}} 1289 local src_input=${1:-${A}}
1117 local src=$(find_unpackable_file "${src_input}") 1290 local src=$(find_unpackable_file "${src_input}")
1118 local skip=$2 1291 local skip=$2
1119 local exe=$3 1292 local exe=$3
1189 ;; 1362 ;;
1190 esac 1363 esac
1191 assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})" 1364 assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})"
1192} 1365}
1193 1366
1367# @FUNCTION: check_license
1368# @USAGE: [license]
1369# @DESCRIPTION:
1194# Display a license for user to accept. 1370# Display a license for user to accept. If no license is
1195#
1196# Usage: check_license [license]
1197# - If the file is not specified then ${LICENSE} is used. 1371# specified, then ${LICENSE} is used.
1198check_license() { 1372check_license() {
1199 local lic=$1 1373 local lic=$1
1200 if [ -z "${lic}" ] ; then 1374 if [ -z "${lic}" ] ; then
1201 lic="${PORTDIR}/licenses/${LICENSE}" 1375 lic="${PORTDIR}/licenses/${LICENSE}"
1202 else 1376 else
1206 lic="${PWD}/${lic}" 1380 lic="${PWD}/${lic}"
1207 elif [ -e "${lic}" ] ; then 1381 elif [ -e "${lic}" ] ; then
1208 lic="${lic}" 1382 lic="${lic}"
1209 fi 1383 fi
1210 fi 1384 fi
1211 [ ! -f "${lic}" ] && die "Could not find requested license ${lic}"
1212 local l="`basename ${lic}`" 1385 local l="`basename ${lic}`"
1213 1386
1214 # here is where we check for the licenses the user already 1387 # here is where we check for the licenses the user already
1215 # accepted ... if we don't find a match, we make the user accept 1388 # accepted ... if we don't find a match, we make the user accept
1216 local shopts=$-
1217 local alic 1389 local alic
1218 set -o noglob #so that bash doesn't expand "*" 1390 eshopts_push -o noglob # so that bash doesn't expand "*"
1219 for alic in ${ACCEPT_LICENSE} ; do 1391 for alic in ${ACCEPT_LICENSE} ; do
1220 if [[ ${alic} == ${l} ]]; then 1392 if [[ ${alic} == ${l} ]]; then
1221 set +o noglob; set -${shopts} #reset old shell opts 1393 eshopts_pop
1222 return 0 1394 return 0
1223 fi 1395 fi
1224 done 1396 done
1225 set +o noglob; set -$shopts #reset old shell opts 1397 eshopts_pop
1398 [ ! -f "${lic}" ] && die "Could not find requested license ${lic}"
1226 1399
1227 local licmsg=$(emktemp) 1400 local licmsg=$(emktemp)
1228 cat <<-EOF > ${licmsg} 1401 cat <<-EOF > ${licmsg}
1229 ********************************************************** 1402 **********************************************************
1230 The following license outlines the terms of use of this 1403 The following license outlines the terms of use of this
1231 package. You MUST accept this license for installation to 1404 package. You MUST accept this license for installation to
1232 continue. When you are done viewing, hit 'q'. If you 1405 continue. When you are done viewing, hit 'q'. If you
1233 CTRL+C out of this, the install will not run! 1406 CTRL+C out of this, the install will not run!
1234 ********************************************************** 1407 **********************************************************
1235 1408
1236 EOF 1409 EOF
1237 cat ${lic} >> ${licmsg} 1410 cat ${lic} >> ${licmsg}
1238 ${PAGER:-less} ${licmsg} || die "Could not execute pager (${PAGER}) to accept ${lic}" 1411 ${PAGER:-less} ${licmsg} || die "Could not execute pager (${PAGER}) to accept ${lic}"
1239 einfon "Do you accept the terms of this license (${l})? [yes/no] " 1412 einfon "Do you accept the terms of this license (${l})? [yes/no] "
1240 read alic 1413 read alic
1248 die "Failed to accept license" 1421 die "Failed to accept license"
1249 ;; 1422 ;;
1250 esac 1423 esac
1251} 1424}
1252 1425
1426# @FUNCTION: cdrom_get_cds
1427# @USAGE: <file on cd1> [file on cd2] [file on cd3] [...]
1428# @DESCRIPTION:
1253# Aquire cd(s) for those lovely cd-based emerges. Yes, this violates 1429# Aquire cd(s) for those lovely cd-based emerges. Yes, this violates
1254# the whole 'non-interactive' policy, but damnit I want CD support ! 1430# the whole 'non-interactive' policy, but damnit I want CD support !
1255# 1431#
1256# with these cdrom functions we handle all the user interaction and 1432# With these cdrom functions we handle all the user interaction and
1257# standardize everything. all you have to do is call cdrom_get_cds() 1433# standardize everything. All you have to do is call cdrom_get_cds()
1258# and when the function returns, you can assume that the cd has been 1434# and when the function returns, you can assume that the cd has been
1259# found at CDROM_ROOT. 1435# found at CDROM_ROOT.
1260# 1436#
1437# The function will attempt to locate a cd based upon a file that is on
1438# the cd. The more files you give this function, the more cds
1439# the cdrom functions will handle.
1440#
1261# normally the cdrom functions will refer to the cds as 'cd #1', 'cd #2', 1441# Normally the cdrom functions will refer to the cds as 'cd #1', 'cd #2',
1262# etc... if you want to give the cds better names, then just export 1442# etc... If you want to give the cds better names, then just export
1263# the appropriate CDROM_NAME variable before calling cdrom_get_cds(). 1443# the appropriate CDROM_NAME variable before calling cdrom_get_cds().
1264# - CDROM_NAME="fooie cd" - for when you only want 1 cd 1444# Use CDROM_NAME for one cd, or CDROM_NAME_# for multiple cds. You can
1265# - CDROM_NAME_1="install cd" - for when you want more than 1 cd 1445# also use the CDROM_NAME_SET bash array.
1266# CDROM_NAME_2="data cd"
1267# - CDROM_NAME_SET=( "install cd" "data cd" ) - short hand for CDROM_NAME_#
1268# 1446#
1269# for those multi cd ebuilds, see the cdrom_load_next_cd() below. 1447# For those multi cd ebuilds, see the cdrom_load_next_cd() function.
1270#
1271# Usage: cdrom_get_cds <file on cd1> [file on cd2] [file on cd3] [...]
1272# - this will attempt to locate a cd based upon a file that is on
1273# the cd ... the more files you give this function, the more cds
1274# the cdrom functions will handle
1275cdrom_get_cds() { 1448cdrom_get_cds() {
1276 # first we figure out how many cds we're dealing with by 1449 # first we figure out how many cds we're dealing with by
1277 # the # of files they gave us 1450 # the # of files they gave us
1278 local cdcnt=0 1451 local cdcnt=0
1279 local f= 1452 local f=
1365 export CDROM_SET="" 1538 export CDROM_SET=""
1366 export CDROM_CURRENT_CD=0 1539 export CDROM_CURRENT_CD=0
1367 cdrom_load_next_cd 1540 cdrom_load_next_cd
1368} 1541}
1369 1542
1370# this is only used when you need access to more than one cd. 1543# @FUNCTION: cdrom_load_next_cd
1371# when you have finished using the first cd, just call this function. 1544# @DESCRIPTION:
1372# when it returns, CDROM_ROOT will be pointing to the second cd. 1545# Some packages are so big they come on multiple CDs. When you're done reading
1373# remember, you can only go forward in the cd chain, you can't go back. 1546# files off a CD and want access to the next one, just call this function.
1547# Again, all the messy details of user interaction are taken care of for you.
1548# Once this returns, just read the variable CDROM_ROOT for the location of the
1549# mounted CD. Note that you can only go forward in the CD list, so make sure
1550# you only call this function when you're done using the current CD.
1374cdrom_load_next_cd() { 1551cdrom_load_next_cd() {
1375 local var 1552 local var
1376 ((++CDROM_CURRENT_CD)) 1553 ((++CDROM_CURRENT_CD))
1377 1554
1378 unset CDROM_ROOT 1555 unset CDROM_ROOT
1395# displayed and we'll hang out here until: 1572# displayed and we'll hang out here until:
1396# (1) the file is found on a mounted cdrom 1573# (1) the file is found on a mounted cdrom
1397# (2) the user hits CTRL+C 1574# (2) the user hits CTRL+C
1398_cdrom_locate_file_on_cd() { 1575_cdrom_locate_file_on_cd() {
1399 local mline="" 1576 local mline=""
1400 local showedmsg=0 1577 local showedmsg=0 showjolietmsg=0
1401 1578
1402 while [[ -z ${CDROM_ROOT} ]] ; do 1579 while [[ -z ${CDROM_ROOT} ]] ; do
1403 local i=0 1580 local i=0
1404 local -a cdset=(${*//:/ }) 1581 local -a cdset=(${*//:/ })
1405 if [[ -n ${CDROM_SET} ]] ; then 1582 if [[ -n ${CDROM_SET} ]] ; then
1414 while read point node fs foo ; do 1591 while read point node fs foo ; do
1415 [[ " cd9660 iso9660 udf " != *" ${fs} "* ]] && \ 1592 [[ " cd9660 iso9660 udf " != *" ${fs} "* ]] && \
1416 ! [[ ${fs} == "subfs" && ",${opts}," == *",fs=cdfss,"* ]] \ 1593 ! [[ ${fs} == "subfs" && ",${opts}," == *",fs=cdfss,"* ]] \
1417 && continue 1594 && continue
1418 point=${point//\040/ } 1595 point=${point//\040/ }
1596 [[ ! -d ${point}/${dir} ]] && continue
1419 [[ -z $(find "${point}/${dir}" -maxdepth 1 -iname "${file}") ]] && continue 1597 [[ -z $(find "${point}/${dir}" -maxdepth 1 -iname "${file}") ]] && continue
1420 export CDROM_ROOT=${point} 1598 export CDROM_ROOT=${point}
1421 export CDROM_SET=${i} 1599 export CDROM_SET=${i}
1422 export CDROM_MATCH=${cdset[${i}]} 1600 export CDROM_MATCH=${cdset[${i}]}
1423 return 1601 return
1445 showedmsg=1 1623 showedmsg=1
1446 fi 1624 fi
1447 einfo "Press return to scan for the cd again" 1625 einfo "Press return to scan for the cd again"
1448 einfo "or hit CTRL+C to abort the emerge." 1626 einfo "or hit CTRL+C to abort the emerge."
1449 echo 1627 echo
1628 if [[ ${showjolietmsg} -eq 0 ]] ; then
1629 showjolietmsg=1
1630 else
1450 einfo "If you are having trouble with the detection" 1631 ewarn "If you are having trouble with the detection"
1451 einfo "of your CD, it is possible that you do not have" 1632 ewarn "of your CD, it is possible that you do not have"
1452 einfo "Joliet support enabled in your kernel. Please" 1633 ewarn "Joliet support enabled in your kernel. Please"
1453 einfo "check that CONFIG_JOLIET is enabled in your kernel." 1634 ewarn "check that CONFIG_JOLIET is enabled in your kernel."
1635 ebeep 5
1636 fi
1454 read || die "something is screwed with your system" 1637 read || die "something is screwed with your system"
1455 done 1638 done
1456} 1639}
1457 1640
1641# @FUNCTION: strip-linguas
1642# @USAGE: [<allow LINGUAS>|<-i|-u> <directories of .po files>]
1643# @DESCRIPTION:
1458# Make sure that LINGUAS only contains languages that 1644# Make sure that LINGUAS only contains languages that
1459# a package can support 1645# a package can support. The first form allows you to
1460# 1646# specify a list of LINGUAS. The -i builds a list of po
1461# usage: strip-linguas <allow LINGUAS> 1647# files found in all the directories and uses the
1462# strip-linguas -i <directories of .po files> 1648# intersection of the lists. The -u builds a list of po
1463# strip-linguas -u <directories of .po files> 1649# files found in all the directories and uses the union
1464# 1650# of the lists.
1465# The first form allows you to specify a list of LINGUAS.
1466# The -i builds a list of po files found in all the
1467# directories and uses the intersection of the lists.
1468# The -u builds a list of po files found in all the
1469# directories and uses the union of the lists.
1470strip-linguas() { 1651strip-linguas() {
1471 local ls newls nols 1652 local ls newls nols
1472 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then 1653 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then
1473 local op=$1; shift 1654 local op=$1; shift
1474 ls=$(find "$1" -name '*.po' -exec basename {} .po \;); shift 1655 ls=$(find "$1" -name '*.po' -exec basename {} .po ';'); shift
1475 local d f 1656 local d f
1476 for d in "$@" ; do 1657 for d in "$@" ; do
1477 if [[ ${op} == "-u" ]] ; then 1658 if [[ ${op} == "-u" ]] ; then
1478 newls=${ls} 1659 newls=${ls}
1479 else 1660 else
1480 newls="" 1661 newls=""
1481 fi 1662 fi
1482 for f in $(find "$d" -name '*.po' -exec basename {} .po \;) ; do 1663 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do
1483 if [[ ${op} == "-i" ]] ; then 1664 if [[ ${op} == "-i" ]] ; then
1484 hasq ${f} ${ls} && newls="${newls} ${f}" 1665 hasq ${f} ${ls} && newls="${newls} ${f}"
1485 else 1666 else
1486 hasq ${f} ${ls} || newls="${newls} ${f}" 1667 hasq ${f} ${ls} || newls="${newls} ${f}"
1487 fi 1668 fi
1500 else 1681 else
1501 nols="${nols} ${f}" 1682 nols="${nols} ${f}"
1502 fi 1683 fi
1503 done 1684 done
1504 [[ -n ${nols} ]] \ 1685 [[ -n ${nols} ]] \
1505 && ewarn "Sorry, but ${PN} does not support the LINGUAs:" ${nols} 1686 && ewarn "Sorry, but ${PN} does not support the LINGUAS:" ${nols}
1506 export LINGUAS=${newls:1} 1687 export LINGUAS=${newls:1}
1507} 1688}
1508 1689
1509# moved from kernel.eclass since they are generally useful outside of 1690# @FUNCTION: preserve_old_lib
1510# kernel.eclass -iggy (20041002) 1691# @USAGE: <libs to preserve> [more libs]
1511 1692# @DESCRIPTION:
1512# the following functions are useful in kernel module ebuilds, etc.
1513# for an example see ivtv or drbd ebuilds
1514
1515# set's ARCH to match what the kernel expects
1516set_arch_to_kernel() {
1517 i=10
1518 while ((i--)) ; do
1519 ewarn "PLEASE UPDATE TO YOUR PACKAGE TO USE linux-info.eclass"
1520 done
1521 export EUTILS_ECLASS_PORTAGE_ARCH="${ARCH}"
1522 case ${ARCH} in
1523 x86) export ARCH="i386";;
1524 amd64) export ARCH="x86_64";;
1525 hppa) export ARCH="parisc";;
1526 mips) export ARCH="mips";;
1527 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!
1528 *) export ARCH="${ARCH}";;
1529 esac
1530}
1531
1532# set's ARCH back to what portage expects
1533set_arch_to_portage() {
1534 i=10
1535 while ((i--)) ; do
1536 ewarn "PLEASE UPDATE TO YOUR PACKAGE TO USE linux-info.eclass"
1537 done
1538 export ARCH="${EUTILS_ECLASS_PORTAGE_ARCH}"
1539}
1540
1541# Jeremy Huddleston <eradicator@gentoo.org>:
1542# preserve_old_lib /path/to/libblah.so.0
1543# preserve_old_lib_notify /path/to/libblah.so.0
1544#
1545# These functions are useful when a lib in your package changes --library. Such 1693# These functions are useful when a lib in your package changes ABI SONAME.
1546# an example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0 1694# An example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0
1547# would break packages that link against it. Most people get around this 1695# would break packages that link against it. Most people get around this
1548# by using the portage SLOT mechanism, but that is not always a relevant 1696# by using the portage SLOT mechanism, but that is not always a relevant
1549# solution, so instead you can add the following to your ebuilds: 1697# solution, so instead you can call this from pkg_preinst. See also the
1550# 1698# preserve_old_lib_notify function.
1551# pkg_preinst() {
1552# ...
1553# preserve_old_lib /usr/$(get_libdir)/libogg.so.0
1554# ...
1555# }
1556#
1557# pkg_postinst() {
1558# ...
1559# preserve_old_lib_notify /usr/$(get_libdir)/libogg.so.0
1560# ...
1561# }
1562
1563preserve_old_lib() { 1699preserve_old_lib() {
1564 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then 1700 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then
1565 eerror "preserve_old_lib() must be called from pkg_preinst() only" 1701 eerror "preserve_old_lib() must be called from pkg_preinst() only"
1566 die "Invalid preserve_old_lib() usage" 1702 die "Invalid preserve_old_lib() usage"
1567 fi 1703 fi
1568 [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]" 1704 [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]"
1705
1706 # let portage worry about it
1707 has preserve-libs ${FEATURES} && return 0
1569 1708
1570 local lib dir 1709 local lib dir
1571 for lib in "$@" ; do 1710 for lib in "$@" ; do
1572 [[ -e ${ROOT}/${lib} ]] || continue 1711 [[ -e ${ROOT}/${lib} ]] || continue
1573 dir=${lib%/*} 1712 dir=${lib%/*}
1575 cp "${ROOT}"/${lib} "${D}"/${lib} || die "cp ${lib} failed" 1714 cp "${ROOT}"/${lib} "${D}"/${lib} || die "cp ${lib} failed"
1576 touch "${D}"/${lib} 1715 touch "${D}"/${lib}
1577 done 1716 done
1578} 1717}
1579 1718
1719# @FUNCTION: preserve_old_lib_notify
1720# @USAGE: <libs to notify> [more libs]
1721# @DESCRIPTION:
1722# Spit helpful messages about the libraries preserved by preserve_old_lib.
1580preserve_old_lib_notify() { 1723preserve_old_lib_notify() {
1581 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then 1724 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then
1582 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only" 1725 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only"
1583 die "Invalid preserve_old_lib_notify() usage" 1726 die "Invalid preserve_old_lib_notify() usage"
1584 fi 1727 fi
1728
1729 # let portage worry about it
1730 has preserve-libs ${FEATURES} && return 0
1585 1731
1586 local lib notice=0 1732 local lib notice=0
1587 for lib in "$@" ; do 1733 for lib in "$@" ; do
1588 [[ -e ${ROOT}/${lib} ]] || continue 1734 [[ -e ${ROOT}/${lib} ]] || continue
1589 if [[ ${notice} -eq 0 ]] ; then 1735 if [[ ${notice} -eq 0 ]] ; then
1595 ewarn "helper program, simply emerge the 'gentoolkit' package." 1741 ewarn "helper program, simply emerge the 'gentoolkit' package."
1596 ewarn 1742 ewarn
1597 fi 1743 fi
1598 ewarn " # revdep-rebuild --library ${lib##*/}" 1744 ewarn " # revdep-rebuild --library ${lib##*/}"
1599 done 1745 done
1746 if [[ ${notice} -eq 1 ]] ; then
1747 ewarn
1748 ewarn "Once you've finished running revdep-rebuild, it should be safe to"
1749 ewarn "delete the old libraries. Here is a copy & paste for the lazy:"
1750 for lib in "$@" ; do
1751 ewarn " # rm '${lib}'"
1752 done
1753 fi
1600} 1754}
1601 1755
1602# Hack for people to figure out if a package was built with 1756# @FUNCTION: built_with_use
1603# certain USE flags
1604#
1605# Usage: built_with_use [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags> 1757# @USAGE: [--hidden] [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags>
1606# ex: built_with_use xchat gtk2 1758# @DESCRIPTION:
1759# A temporary hack until portage properly supports DEPENDing on USE
1760# flags being enabled in packages. This will check to see if the specified
1761# DEPEND atom was built with the specified list of USE flags. The
1762# --missing option controls the behavior if called on a package that does
1763# not actually support the defined USE flags (aka listed in IUSE).
1764# The default is to abort (call die). The -a and -o flags control
1765# the requirements of the USE flags. They correspond to "and" and "or"
1766# logic. So the -a flag means all listed USE flags must be enabled
1767# while the -o flag means at least one of the listed IUSE flags must be
1768# enabled. The --hidden option is really for internal use only as it
1769# means the USE flag we're checking is hidden expanded, so it won't be found
1770# in IUSE like normal USE flags.
1607# 1771#
1608# Flags: -a all USE flags should be utilized 1772# Remember that this function isn't terribly intelligent so order of optional
1609# -o at least one USE flag should be utilized 1773# flags matter.
1610# --missing peform the specified action if the flag is not in IUSE (true/false/die)
1611# --hidden USE flag we're checking is hidden expanded so it isnt in IUSE
1612# Note: the default flag is '-a'
1613built_with_use() { 1774built_with_use() {
1614 local hidden="no" 1775 local hidden="no"
1615 if [[ $1 == "--hidden" ]] ; then 1776 if [[ $1 == "--hidden" ]] ; then
1616 hidden="yes" 1777 hidden="yes"
1617 shift 1778 shift
1646 die) die "Unable to determine what USE flags $PKG was built with";; 1807 die) die "Unable to determine what USE flags $PKG was built with";;
1647 esac 1808 esac
1648 fi 1809 fi
1649 1810
1650 if [[ ${hidden} == "no" ]] ; then 1811 if [[ ${hidden} == "no" ]] ; then
1651 local IUSE_BUILT=$(<${IUSEFILE}) 1812 local IUSE_BUILT=( $(<"${IUSEFILE}") )
1652 # Don't check USE_EXPAND #147237 1813 # Don't check USE_EXPAND #147237
1653 local expand 1814 local expand
1654 for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do 1815 for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do
1655 if [[ $1 == ${expand}_* ]] ; then 1816 if [[ $1 == ${expand}_* ]] ; then
1656 expand="" 1817 expand=""
1657 break 1818 break
1658 fi 1819 fi
1659 done 1820 done
1660 if [[ -n ${expand} ]] ; then 1821 if [[ -n ${expand} ]] ; then
1661 if ! has $1 ${IUSE_BUILT} ; then 1822 if ! has $1 ${IUSE_BUILT[@]#[-+]} ; then
1662 case ${missing_action} in 1823 case ${missing_action} in
1663 true) return 0;; 1824 true) return 0;;
1664 false) return 1;; 1825 false) return 1;;
1665 die) die "$PKG does not actually support the $1 USE flag!";; 1826 die) die "$PKG does not actually support the $1 USE flag!";;
1666 esac 1827 esac
1678 shift 1839 shift
1679 done 1840 done
1680 [[ ${opt} = "-a" ]] 1841 [[ ${opt} = "-a" ]]
1681} 1842}
1682 1843
1844# @FUNCTION: epunt_cxx
1845# @USAGE: [dir to scan]
1846# @DESCRIPTION:
1683# Many configure scripts wrongly bail when a C++ compiler 1847# Many configure scripts wrongly bail when a C++ compiler could not be
1684# could not be detected. #73450 1848# detected. If dir is not specified, then it defaults to ${S}.
1849#
1850# http://bugs.gentoo.org/73450
1685epunt_cxx() { 1851epunt_cxx() {
1686 local dir=$1 1852 local dir=$1
1687 [[ -z ${dir} ]] && dir=${S} 1853 [[ -z ${dir} ]] && dir=${S}
1688 ebegin "Removing useless C++ checks" 1854 ebegin "Removing useless C++ checks"
1689 local f 1855 local f
1690 for f in $(find ${dir} -name configure) ; do 1856 find "${dir}" -name configure | while read f ; do
1691 patch -p0 "${f}" "${PORTDIR}/eclass/ELT-patches/nocxx/nocxx.patch" > /dev/null 1857 patch --no-backup-if-mismatch -p0 "${f}" "${PORTDIR}/eclass/ELT-patches/nocxx/nocxx.patch" > /dev/null
1692 done 1858 done
1693 eend 0 1859 eend 0
1694} 1860}
1695 1861
1696# make a wrapper script ... 1862# @FUNCTION: make_wrapper
1697# NOTE: this was originally games_make_wrapper, but I noticed other places where 1863# @USAGE: <wrapper> <target> [chdir] [libpaths] [installpath]
1698# this could be used, so I have moved it here and made it not games-specific 1864# @DESCRIPTION:
1699# -- wolf31o2 1865# Create a shell wrapper script named wrapper in installpath
1700# $1 == wrapper name 1866# (defaults to the bindir) to execute target (default of wrapper) by
1701# $2 == binary to run 1867# first optionally setting LD_LIBRARY_PATH to the colon-delimited
1702# $3 == directory to chdir before running binary 1868# libpaths followed by optionally changing directory to chdir.
1703# $4 == extra LD_LIBRARY_PATH's (make it : delimited)
1704# $5 == path for wrapper
1705make_wrapper() { 1869make_wrapper() {
1706 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5 1870 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5
1707 local tmpwrapper=$(emktemp) 1871 local tmpwrapper=$(emktemp)
1708 # We don't want to quote ${bin} so that people can pass complex 1872 # We don't want to quote ${bin} so that people can pass complex
1709 # things as $bin ... "./someprog --args" 1873 # things as $bin ... "./someprog --args"
1719fi 1883fi
1720exec ${bin} "\$@" 1884exec ${bin} "\$@"
1721EOF 1885EOF
1722 chmod go+rx "${tmpwrapper}" 1886 chmod go+rx "${tmpwrapper}"
1723 if [[ -n ${path} ]] ; then 1887 if [[ -n ${path} ]] ; then
1888 (
1724 exeinto "${path}" 1889 exeinto "${path}"
1725 newexe "${tmpwrapper}" "${wrapper}" 1890 newexe "${tmpwrapper}" "${wrapper}"
1891 ) || die
1726 else 1892 else
1727 newbin "${tmpwrapper}" "${wrapper}" 1893 newbin "${tmpwrapper}" "${wrapper}" || die
1894 fi
1895}
1896
1897# @FUNCTION: prepalldocs
1898# @USAGE:
1899# @DESCRIPTION:
1900# Compress files in /usr/share/doc which are not already
1901# compressed, excluding /usr/share/doc/${PF}/html.
1902# Uses the ecompressdir to do the compression.
1903# 2009-02-18 by betelgeuse:
1904# Commented because ecompressdir is even more internal to
1905# Portage than prepalldocs (it's not even mentioned in man 5
1906# ebuild). Please submit a better version for review to gentoo-dev
1907# if you want prepalldocs here.
1908#prepalldocs() {
1909# if [[ -n $1 ]] ; then
1910# ewarn "prepalldocs: invalid usage; takes no arguments"
1728 fi 1911# fi
1729} 1912
1913# cd "${D}"
1914# [[ -d usr/share/doc ]] || return 0
1915
1916# find usr/share/doc -exec gzip {} +
1917# ecompressdir --ignore /usr/share/doc/${PF}/html
1918# ecompressdir --queue /usr/share/doc
1919#}

Legend:
Removed from v.1.282  
changed lines
  Added in v.1.324

  ViewVC Help
Powered by ViewVC 1.1.20