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

Diff of /eclass/eutils.eclass

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

Revision 1.348 Revision 1.373
1# Copyright 1999-2009 Gentoo Foundation 1# Copyright 1999-2011 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.348 2010/07/11 17:29:10 betelgeuse Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.373 2011/12/16 23:38:41 vapier Exp $
4 4
5# @ECLASS: eutils.eclass 5# @ECLASS: eutils.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# base-system@gentoo.org 7# base-system@gentoo.org
8# @BLURB: many extra (but common) functions that are used in ebuilds 8# @BLURB: many extra (but common) functions that are used in ebuilds
13# home rather than having multiple ebuilds implementing the same thing. 13# home rather than having multiple ebuilds implementing the same thing.
14# 14#
15# Due to the nature of this eclass, some functions may have maintainers 15# Due to the nature of this eclass, some functions may have maintainers
16# different from the overall eclass! 16# different from the overall eclass!
17 17
18if [[ ${___ECLASS_ONCE_EUTILS} != "recur -_+^+_- spank" ]] ; then
19___ECLASS_ONCE_EUTILS="recur -_+^+_- spank"
20
18inherit multilib portability 21inherit multilib portability user
19 22
20DESCRIPTION="Based on the ${ECLASS} eclass" 23DESCRIPTION="Based on the ${ECLASS} eclass"
21 24
22if has "${EAPI:-0}" 0 1 2; then 25if has "${EAPI:-0}" 0 1 2; then
23 26
64fi 67fi
65 68
66# @FUNCTION: eqawarn 69# @FUNCTION: eqawarn
67# @USAGE: [message] 70# @USAGE: [message]
68# @DESCRIPTION: 71# @DESCRIPTION:
69# Proxy to einfo for package managers that don't provide eqawarn and use the PM 72# Proxy to ewarn for package managers that don't provide eqawarn and use the PM
70# implementation if available. 73# implementation if available. Reuses PORTAGE_ELOG_CLASSES as set by the dev
74# profile.
71if ! declare -F eqawarn >/dev/null ; then 75if ! declare -F eqawarn >/dev/null ; then
72 eqawarn() { 76 eqawarn() {
73 einfo "$@" 77 has qa ${PORTAGE_ELOG_CLASSES} && ewarn "$@"
78 :
74 } 79 }
75fi 80fi
76 81
77# @FUNCTION: ecvs_clean 82# @FUNCTION: ecvs_clean
78# @USAGE: [list of dirs] 83# @USAGE: [list of dirs]
91# Remove .svn directories recursiveley. Useful when a source tarball contains 96# Remove .svn directories recursiveley. Useful when a source tarball contains
92# internal Subversion directories. Defaults to $PWD. 97# internal Subversion directories. Defaults to $PWD.
93esvn_clean() { 98esvn_clean() {
94 [[ -z $* ]] && set -- . 99 [[ -z $* ]] && set -- .
95 find "$@" -type d -name '.svn' -prune -print0 | xargs -0 rm -rf 100 find "$@" -type d -name '.svn' -prune -print0 | xargs -0 rm -rf
101}
102
103# @FUNCTION: estack_push
104# @USAGE: <stack> [items to push]
105# @DESCRIPTION:
106# Push any number of items onto the specified stack. Pick a name that
107# is a valid variable (i.e. stick to alphanumerics), and push as many
108# items as you like onto the stack at once.
109#
110# The following code snippet will echo 5, then 4, then 3, then ...
111# @CODE
112# estack_push mystack 1 2 3 4 5
113# while estack_pop mystack i ; do
114# echo "${i}"
115# done
116# @CODE
117estack_push() {
118 [[ $# -eq 0 ]] && die "estack_push: incorrect # of arguments"
119 local stack_name="__ESTACK_$1__" ; shift
120 eval ${stack_name}+=\( \"\$@\" \)
121}
122
123# @FUNCTION: estack_pop
124# @USAGE: <stack> [variable]
125# @DESCRIPTION:
126# Pop a single item off the specified stack. If a variable is specified,
127# the popped item is stored there. If no more items are available, return
128# 1, else return 0. See estack_push for more info.
129estack_pop() {
130 [[ $# -eq 0 || $# -gt 2 ]] && die "estack_pop: incorrect # of arguments"
131
132 # We use the fugly __estack_xxx var names to avoid collision with
133 # passing back the return value. If we used "local i" and the
134 # caller ran `estack_pop ... i`, we'd end up setting the local
135 # copy of "i" rather than the caller's copy. The __estack_xxx
136 # garbage is preferable to using $1/$2 everywhere as that is a
137 # bit harder to read.
138 local __estack_name="__ESTACK_$1__" ; shift
139 local __estack_retvar=$1 ; shift
140 eval local __estack_i=\${#${__estack_name}[@]}
141 # Don't warn -- let the caller interpret this as a failure
142 # or as normal behavior (akin to `shift`)
143 [[ $(( --__estack_i )) -eq -1 ]] && return 1
144
145 if [[ -n ${__estack_retvar} ]] ; then
146 eval ${__estack_retvar}=\"\${${__estack_name}[${__estack_i}]}\"
147 fi
148 eval unset ${__estack_name}[${__estack_i}]
96} 149}
97 150
98# @FUNCTION: eshopts_push 151# @FUNCTION: eshopts_push
99# @USAGE: [options to `set` or `shopt`] 152# @USAGE: [options to `set` or `shopt`]
100# @DESCRIPTION: 153# @DESCRIPTION:
119# eshopts_pop 172# eshopts_pop
120# @CODE 173# @CODE
121eshopts_push() { 174eshopts_push() {
122 # have to assume __ESHOPTS_SAVE__ isn't screwed with 175 # have to assume __ESHOPTS_SAVE__ isn't screwed with
123 # as a `declare -a` here will reset its value 176 # as a `declare -a` here will reset its value
124 local i=${#__ESHOPTS_SAVE__[@]}
125 if [[ $1 == -[su] ]] ; then 177 if [[ $1 == -[su] ]] ; then
126 __ESHOPTS_SAVE__[$i]=$(shopt -p) 178 estack_push eshopts "$(shopt -p)"
127 [[ $# -eq 0 ]] && return 0 179 [[ $# -eq 0 ]] && return 0
128 shopt "$@" || die "eshopts_push: bad options to shopt: $*" 180 shopt "$@" || die "${FUNCNAME}: bad options to shopt: $*"
129 else 181 else
130 __ESHOPTS_SAVE__[$i]=$- 182 estack_push eshopts $-
131 [[ $# -eq 0 ]] && return 0 183 [[ $# -eq 0 ]] && return 0
132 set "$@" || die "eshopts_push: bad options to set: $*" 184 set "$@" || die "${FUNCNAME}: bad options to set: $*"
133 fi 185 fi
134} 186}
135 187
136# @FUNCTION: eshopts_pop 188# @FUNCTION: eshopts_pop
137# @USAGE: 189# @USAGE:
138# @DESCRIPTION: 190# @DESCRIPTION:
139# Restore the shell options to the state saved with the corresponding 191# Restore the shell options to the state saved with the corresponding
140# eshopts_push call. See that function for more details. 192# eshopts_push call. See that function for more details.
141eshopts_pop() { 193eshopts_pop() {
142 [[ $# -ne 0 ]] && die "eshopts_pop takes no arguments" 194 local s
143 local i=$(( ${#__ESHOPTS_SAVE__[@]} - 1 )) 195 estack_pop eshopts s || die "${FUNCNAME}: unbalanced push"
144 [[ ${i} -eq -1 ]] && die "eshopts_{push,pop}: unbalanced pair"
145 local s=${__ESHOPTS_SAVE__[$i]}
146 unset __ESHOPTS_SAVE__[$i]
147 if [[ ${s} == "shopt -"* ]] ; then 196 if [[ ${s} == "shopt -"* ]] ; then
148 eval "${s}" || die "eshopts_pop: sanity: invalid shopt options: ${s}" 197 eval "${s}" || die "${FUNCNAME}: sanity: invalid shopt options: ${s}"
149 else 198 else
150 set +$- || die "eshopts_pop: sanity: invalid shell settings: $-" 199 set +$- || die "${FUNCNAME}: sanity: invalid shell settings: $-"
151 set -${s} || die "eshopts_pop: sanity: unable to restore saved shell settings: ${s}" 200 set -${s} || die "${FUNCNAME}: sanity: unable to restore saved shell settings: ${s}"
152 fi 201 fi
202}
203
204# @FUNCTION: eumask_push
205# @USAGE: <new umask>
206# @DESCRIPTION:
207# Set the umask to the new value specified while saving the previous
208# value onto a stack. Useful for temporarily changing the umask.
209eumask_push() {
210 estack_push eumask "$(umask)"
211 umask "$@" || die "${FUNCNAME}: bad options to umask: $*"
212}
213
214# @FUNCTION: eumask_pop
215# @USAGE:
216# @DESCRIPTION:
217# Restore the previous umask state.
218eumask_pop() {
219 local s
220 estack_pop eumask s || die "${FUNCNAME}: unbalanced push"
221 umask ${s} || die "${FUNCNAME}: sanity: could not restore umask: ${s}"
153} 222}
154 223
155# @VARIABLE: EPATCH_SOURCE 224# @VARIABLE: EPATCH_SOURCE
156# @DESCRIPTION: 225# @DESCRIPTION:
157# Default directory to search for patches. 226# Default directory to search for patches.
200# If you do not specify any options, then epatch will default to the directory 269# If you do not specify any options, then epatch will default to the directory
201# specified by EPATCH_SOURCE. 270# specified by EPATCH_SOURCE.
202# 271#
203# When processing directories, epatch will apply all patches that match: 272# When processing directories, epatch will apply all patches that match:
204# @CODE 273# @CODE
205# ${EPATCH_FORCE} == "yes" 274# if ${EPATCH_FORCE} != "yes"
206# ??_${ARCH}_foo.${EPATCH_SUFFIX} 275# ??_${ARCH}_foo.${EPATCH_SUFFIX}
207# else 276# else
208# *.${EPATCH_SUFFIX} 277# *.${EPATCH_SUFFIX}
209# @CODE 278# @CODE
210# The leading ?? are typically numbers used to force consistent patch ordering. 279# The leading ?? are typically numbers used to force consistent patch ordering.
249 local EPATCH_SUFFIX=$1 318 local EPATCH_SUFFIX=$1
250 319
251 elif [[ -d $1 ]] ; then 320 elif [[ -d $1 ]] ; then
252 # Some people like to make dirs of patches w/out suffixes (vim) 321 # Some people like to make dirs of patches w/out suffixes (vim)
253 set -- "$1"/*${EPATCH_SUFFIX:+."${EPATCH_SUFFIX}"} 322 set -- "$1"/*${EPATCH_SUFFIX:+."${EPATCH_SUFFIX}"}
323
324 elif [[ -f ${EPATCH_SOURCE}/$1 ]] ; then
325 # Re-use EPATCH_SOURCE as a search dir
326 epatch "${EPATCH_SOURCE}/$1"
327 return $?
254 328
255 else 329 else
256 # sanity check ... if it isn't a dir or file, wtf man ? 330 # sanity check ... if it isn't a dir or file, wtf man ?
257 [[ $# -ne 0 ]] && EPATCH_SOURCE=$1 331 [[ $# -ne 0 ]] && EPATCH_SOURCE=$1
258 echo 332 echo
289 # ???_arch_foo.patch 363 # ???_arch_foo.patch
290 # Else, skip this input altogether 364 # Else, skip this input altogether
291 local a=${patchname#*_} # strip the ???_ 365 local a=${patchname#*_} # strip the ???_
292 a=${a%%_*} # strip the _foo.patch 366 a=${a%%_*} # strip the _foo.patch
293 if ! [[ ${SINGLE_PATCH} == "yes" || \ 367 if ! [[ ${SINGLE_PATCH} == "yes" || \
294 ${EPATCH_FORCE} == "yes" || \ 368 ${EPATCH_FORCE} == "yes" || \
295 ${a} == all || \ 369 ${a} == all || \
296 ${a} == ${ARCH} ]] 370 ${a} == ${ARCH} ]]
297 then 371 then
298 continue 372 continue
299 fi 373 fi
300 374
301 # Let people filter things dynamically 375 # Let people filter things dynamically
329 local STDERR_TARGET="${T}/${patchname}.out" 403 local STDERR_TARGET="${T}/${patchname}.out"
330 if [[ -e ${STDERR_TARGET} ]] ; then 404 if [[ -e ${STDERR_TARGET} ]] ; then
331 STDERR_TARGET="${T}/${patchname}-$$.out" 405 STDERR_TARGET="${T}/${patchname}-$$.out"
332 fi 406 fi
333 407
334 printf "***** %s *****\n\n" "${patchname}" > "${STDERR_TARGET}" 408 printf "***** %s *****\nPWD: %s\n\n" "${patchname}" "${PWD}" > "${STDERR_TARGET}"
335 409
336 # Decompress the patch if need be 410 # Decompress the patch if need be
337 local count=0 411 local count=0
338 local PATCH_TARGET 412 local PATCH_TARGET
339 if [[ -n ${PIPE_CMD} ]] ; then 413 if [[ -n ${PIPE_CMD} ]] ; then
358 local abs_paths=$(egrep -n '^[-+]{3} /' "${PATCH_TARGET}" | awk '$2 != "/dev/null" { print }') 432 local abs_paths=$(egrep -n '^[-+]{3} /' "${PATCH_TARGET}" | awk '$2 != "/dev/null" { print }')
359 if [[ -n ${abs_paths} ]] ; then 433 if [[ -n ${abs_paths} ]] ; then
360 count=1 434 count=1
361 printf "NOTE: skipping -p0 due to absolute paths in patch:\n%s\n" "${abs_paths}" >> "${STDERR_TARGET}" 435 printf "NOTE: skipping -p0 due to absolute paths in patch:\n%s\n" "${abs_paths}" >> "${STDERR_TARGET}"
362 fi 436 fi
437 # Similar reason, but with relative paths.
438 local rel_paths=$(egrep -n '^[-+]{3} [^ ]*[.][.]/' "${PATCH_TARGET}")
439 if [[ -n ${rel_paths} ]] ; then
440 eqawarn "QA Notice: Your patch uses relative paths '../'."
441 eqawarn " In the future this will cause a failure."
442 eqawarn "${rel_paths}"
443 fi
363 444
364 # Dynamically detect the correct -p# ... i'm lazy, so shoot me :/ 445 # Dynamically detect the correct -p# ... i'm lazy, so shoot me :/
365 while [[ ${count} -lt 5 ]] ; do 446 while [[ ${count} -lt 5 ]] ; do
366 # Generate some useful debug info ... 447 # Generate some useful debug info ...
367 ( 448 (
368 _epatch_draw_line "***** ${patchname} *****" 449 _epatch_draw_line "***** ${patchname} *****"
369 echo 450 echo
370 echo "PATCH COMMAND: patch -p${count} ${EPATCH_OPTS} < '${PATCH_TARGET}'" 451 echo "PATCH COMMAND: patch -p${count} ${EPATCH_OPTS} < '${PATCH_TARGET}'"
371 echo 452 echo
372 _epatch_draw_line "***** ${patchname} *****" 453 _epatch_draw_line "***** ${patchname} *****"
454 patch -p${count} ${EPATCH_OPTS} --dry-run -f < "${PATCH_TARGET}" 2>&1
455 ret=$?
456 echo
457 echo "patch program exited with status ${ret}"
458 exit ${ret}
373 ) >> "${STDERR_TARGET}" 459 ) >> "${STDERR_TARGET}"
374 460
375 if (patch -p${count} ${EPATCH_OPTS} --dry-run -f < "${PATCH_TARGET}") >> "${STDERR_TARGET}" 2>&1 ; then 461 if [ $? -eq 0 ] ; then
376 ( 462 (
377 _epatch_draw_line "***** ${patchname} *****" 463 _epatch_draw_line "***** ${patchname} *****"
378 echo 464 echo
379 echo "ACTUALLY APPLYING ${patchname} ..." 465 echo "ACTUALLY APPLYING ${patchname} ..."
380 echo 466 echo
381 _epatch_draw_line "***** ${patchname} *****" 467 _epatch_draw_line "***** ${patchname} *****"
382 patch -p${count} ${EPATCH_OPTS} < "${PATCH_TARGET}" 2>&1 468 patch -p${count} ${EPATCH_OPTS} < "${PATCH_TARGET}" 2>&1
469 ret=$?
470 echo
471 echo "patch program exited with status ${ret}"
472 exit ${ret}
383 ) >> "${STDERR_TARGET}" 473 ) >> "${STDERR_TARGET}"
384 474
385 if [ $? -ne 0 ] ; then 475 if [ $? -ne 0 ] ; then
386 echo 476 echo
387 eerror "A dry-run of patch command succeeded, but actually" 477 eerror "A dry-run of patch command succeeded, but actually"
418 done 508 done
419 509
420 [[ ${SINGLE_PATCH} == "no" ]] && einfo "Done with patching" 510 [[ ${SINGLE_PATCH} == "no" ]] && einfo "Done with patching"
421 : # everything worked 511 : # everything worked
422} 512}
513
514# @FUNCTION: epatch_user
515# @USAGE:
516# @DESCRIPTION:
517# Applies user-provided patches to the source tree. The patches are
518# taken from /etc/portage/patches/<CATEGORY>/<PF|P|PN>/, where the first
519# of these three directories to exist will be the one to use, ignoring
520# any more general directories which might exist as well.
521#
522# User patches are intended for quick testing of patches without ebuild
523# modifications, as well as for permanent customizations a user might
524# desire. Obviously, there can be no official support for arbitrarily
525# patched ebuilds. So whenever a build log in a bug report mentions that
526# user patches were applied, the user should be asked to reproduce the
527# problem without these.
528#
529# Not all ebuilds do call this function, so placing patches in the
530# stated directory might or might not work, depending on the package and
531# the eclasses it inherits and uses. It is safe to call the function
532# repeatedly, so it is always possible to add a call at the ebuild
533# level. The first call is the time when the patches will be
534# applied.
535#
536# Ideally, this function should be called after gentoo-specific patches
537# have been applied, so that their code can be modified as well, but
538# before calls to e.g. eautoreconf, as the user patches might affect
539# autotool input files as well.
423epatch_user() { 540epatch_user() {
424 [[ $# -ne 0 ]] && die "epatch_user takes no options" 541 [[ $# -ne 0 ]] && die "epatch_user takes no options"
542
543 # Allow multiple calls to this function; ignore all but the first
544 local applied="${T}/epatch_user.applied"
545 [[ -e ${applied} ]] && return 2
425 546
426 # don't clobber any EPATCH vars that the parent might want 547 # don't clobber any EPATCH vars that the parent might want
427 local EPATCH_SOURCE check base=${PORTAGE_CONFIGROOT%/}/etc/portage/patches 548 local EPATCH_SOURCE check base=${PORTAGE_CONFIGROOT%/}/etc/portage/patches
428 for check in {${CATEGORY}/${PF},${CATEGORY}/${P},${CATEGORY}/${PN}}; do 549 for check in {${CATEGORY}/${PF},${CATEGORY}/${P},${CATEGORY}/${PN}}; do
429 EPATCH_SOURCE=${base}/${CTARGET}/${check} 550 EPATCH_SOURCE=${base}/${CTARGET}/${check}
433 EPATCH_SOURCE=${EPATCH_SOURCE} \ 554 EPATCH_SOURCE=${EPATCH_SOURCE} \
434 EPATCH_SUFFIX="patch" \ 555 EPATCH_SUFFIX="patch" \
435 EPATCH_FORCE="yes" \ 556 EPATCH_FORCE="yes" \
436 EPATCH_MULTI_MSG="Applying user patches from ${EPATCH_SOURCE} ..." \ 557 EPATCH_MULTI_MSG="Applying user patches from ${EPATCH_SOURCE} ..." \
437 epatch 558 epatch
438 break 559 echo "${EPATCH_SOURCE}" > "${applied}"
560 return 0
439 fi 561 fi
440 done 562 done
563 echo "none" > "${applied}"
564 return 1
441} 565}
442 566
443# @FUNCTION: emktemp 567# @FUNCTION: emktemp
444# @USAGE: [temp dir] 568# @USAGE: [temp dir]
445# @DESCRIPTION: 569# @DESCRIPTION:
473 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX 597 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX
474 fi 598 fi
475 fi 599 fi
476} 600}
477 601
478# @FUNCTION: egetent
479# @USAGE: <database> <key>
480# @MAINTAINER:
481# base-system@gentoo.org (Linux)
482# Joe Jezak <josejx@gmail.com> (OS X)
483# usata@gentoo.org (OS X)
484# Aaron Walker <ka0ttic@gentoo.org> (FreeBSD)
485# @DESCRIPTION:
486# Small wrapper for getent (Linux),
487# nidump (< Mac OS X 10.5), dscl (Mac OS X 10.5),
488# and pw (FreeBSD) used in enewuser()/enewgroup()
489egetent() {
490 case ${CHOST} in
491 *-darwin[678])
492 case "$2" in
493 *[!0-9]*) # Non numeric
494 nidump $1 . | awk -F":" "{ if (\$1 ~ /^$2$/) {print \$0;exit;} }"
495 ;;
496 *) # Numeric
497 nidump $1 . | awk -F":" "{ if (\$3 == $2) {print \$0;exit;} }"
498 ;;
499 esac
500 ;;
501 *-darwin*)
502 local mytype=$1
503 [[ "passwd" == $mytype ]] && mytype="Users"
504 [[ "group" == $mytype ]] && mytype="Groups"
505 case "$2" in
506 *[!0-9]*) # Non numeric
507 dscl . -read /$mytype/$2 2>/dev/null |grep RecordName
508 ;;
509 *) # Numeric
510 local mykey="UniqueID"
511 [[ $mytype == "Groups" ]] && mykey="PrimaryGroupID"
512 dscl . -search /$mytype $mykey $2 2>/dev/null
513 ;;
514 esac
515 ;;
516 *-freebsd*|*-dragonfly*)
517 local opts action="user"
518 [[ $1 == "passwd" ]] || action="group"
519
520 # lookup by uid/gid
521 if [[ $2 == [[:digit:]]* ]] ; then
522 [[ ${action} == "user" ]] && opts="-u" || opts="-g"
523 fi
524
525 pw show ${action} ${opts} "$2" -q
526 ;;
527 *-netbsd*|*-openbsd*)
528 grep "$2:\*:" /etc/$1
529 ;;
530 *)
531 type -p nscd >& /dev/null && nscd -i "$1"
532 getent "$1" "$2"
533 ;;
534 esac
535}
536
537# @FUNCTION: enewuser
538# @USAGE: <user> [uid] [shell] [homedir] [groups] [params]
539# @DESCRIPTION:
540# Same as enewgroup, you are not required to understand how to properly add
541# a user to the system. The only required parameter is the username.
542# Default uid is (pass -1 for this) next available, default shell is
543# /bin/false, default homedir is /dev/null, there are no default groups,
544# and default params sets the comment as 'added by portage for ${PN}'.
545enewuser() {
546 case ${EBUILD_PHASE} in
547 unpack|compile|test|install)
548 eerror "'enewuser()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
549 eerror "Package fails at QA and at life. Please file a bug."
550 die "Bad package! enewuser is only for use in pkg_* functions!"
551 esac
552
553 # get the username
554 local euser=$1; shift
555 if [[ -z ${euser} ]] ; then
556 eerror "No username specified !"
557 die "Cannot call enewuser without a username"
558 fi
559
560 # lets see if the username already exists
561 if [[ -n $(egetent passwd "${euser}") ]] ; then
562 return 0
563 fi
564 einfo "Adding user '${euser}' to your system ..."
565
566 # options to pass to useradd
567 local opts=
568
569 # handle uid
570 local euid=$1; shift
571 if [[ -n ${euid} && ${euid} != -1 ]] ; then
572 if [[ ${euid} -gt 0 ]] ; then
573 if [[ -n $(egetent passwd ${euid}) ]] ; then
574 euid="next"
575 fi
576 else
577 eerror "Userid given but is not greater than 0 !"
578 die "${euid} is not a valid UID"
579 fi
580 else
581 euid="next"
582 fi
583 if [[ ${euid} == "next" ]] ; then
584 for ((euid = 101; euid <= 999; euid++)); do
585 [[ -z $(egetent passwd ${euid}) ]] && break
586 done
587 fi
588 opts="${opts} -u ${euid}"
589 einfo " - Userid: ${euid}"
590
591 # handle shell
592 local eshell=$1; shift
593 if [[ ! -z ${eshell} ]] && [[ ${eshell} != "-1" ]] ; then
594 if [[ ! -e ${ROOT}${eshell} ]] ; then
595 eerror "A shell was specified but it does not exist !"
596 die "${eshell} does not exist in ${ROOT}"
597 fi
598 if [[ ${eshell} == */false || ${eshell} == */nologin ]] ; then
599 eerror "Do not specify ${eshell} yourself, use -1"
600 die "Pass '-1' as the shell parameter"
601 fi
602 else
603 for shell in /sbin/nologin /usr/sbin/nologin /bin/false /usr/bin/false /dev/null ; do
604 [[ -x ${ROOT}${shell} ]] && break
605 done
606
607 if [[ ${shell} == "/dev/null" ]] ; then
608 eerror "Unable to identify the shell to use, proceeding with userland default."
609 case ${USERLAND} in
610 GNU) shell="/bin/false" ;;
611 BSD) shell="/sbin/nologin" ;;
612 Darwin) shell="/usr/sbin/nologin" ;;
613 *) die "Unable to identify the default shell for userland ${USERLAND}"
614 esac
615 fi
616
617 eshell=${shell}
618 fi
619 einfo " - Shell: ${eshell}"
620 opts="${opts} -s ${eshell}"
621
622 # handle homedir
623 local ehome=$1; shift
624 if [[ -z ${ehome} ]] || [[ ${ehome} == "-1" ]] ; then
625 ehome="/dev/null"
626 fi
627 einfo " - Home: ${ehome}"
628 opts="${opts} -d ${ehome}"
629
630 # handle groups
631 local egroups=$1; shift
632 if [[ ! -z ${egroups} ]] ; then
633 local oldifs=${IFS}
634 local defgroup="" exgroups=""
635
636 export IFS=","
637 for g in ${egroups} ; do
638 export IFS=${oldifs}
639 if [[ -z $(egetent group "${g}") ]] ; then
640 eerror "You must add group ${g} to the system first"
641 die "${g} is not a valid GID"
642 fi
643 if [[ -z ${defgroup} ]] ; then
644 defgroup=${g}
645 else
646 exgroups="${exgroups},${g}"
647 fi
648 export IFS=","
649 done
650 export IFS=${oldifs}
651
652 opts="${opts} -g ${defgroup}"
653 if [[ ! -z ${exgroups} ]] ; then
654 opts="${opts} -G ${exgroups:1}"
655 fi
656 else
657 egroups="(none)"
658 fi
659 einfo " - Groups: ${egroups}"
660
661 # handle extra and add the user
662 local oldsandbox=${SANDBOX_ON}
663 export SANDBOX_ON="0"
664 case ${CHOST} in
665 *-darwin*)
666 ### Make the user
667 if [[ -z $@ ]] ; then
668 dscl . create /users/${euser} uid ${euid}
669 dscl . create /users/${euser} shell ${eshell}
670 dscl . create /users/${euser} home ${ehome}
671 dscl . create /users/${euser} realname "added by portage for ${PN}"
672 ### Add the user to the groups specified
673 local oldifs=${IFS}
674 export IFS=","
675 for g in ${egroups} ; do
676 dscl . merge /groups/${g} users ${euser}
677 done
678 export IFS=${oldifs}
679 else
680 einfo "Extra options are not supported on Darwin yet"
681 einfo "Please report the ebuild along with the info below"
682 einfo "eextra: $@"
683 die "Required function missing"
684 fi
685 ;;
686 *-freebsd*|*-dragonfly*)
687 if [[ -z $@ ]] ; then
688 pw useradd ${euser} ${opts} \
689 -c "added by portage for ${PN}" \
690 die "enewuser failed"
691 else
692 einfo " - Extra: $@"
693 pw useradd ${euser} ${opts} \
694 "$@" || die "enewuser failed"
695 fi
696 ;;
697
698 *-netbsd*)
699 if [[ -z $@ ]] ; then
700 useradd ${opts} ${euser} || die "enewuser failed"
701 else
702 einfo " - Extra: $@"
703 useradd ${opts} ${euser} "$@" || die "enewuser failed"
704 fi
705 ;;
706
707 *-openbsd*)
708 if [[ -z $@ ]] ; then
709 useradd -u ${euid} -s ${eshell} \
710 -d ${ehome} -c "Added by portage for ${PN}" \
711 -g ${egroups} ${euser} || die "enewuser failed"
712 else
713 einfo " - Extra: $@"
714 useradd -u ${euid} -s ${eshell} \
715 -d ${ehome} -c "Added by portage for ${PN}" \
716 -g ${egroups} ${euser} "$@" || die "enewuser failed"
717 fi
718 ;;
719
720 *)
721 if [[ -z $@ ]] ; then
722 useradd -r ${opts} \
723 -c "added by portage for ${PN}" \
724 ${euser} \
725 || die "enewuser failed"
726 else
727 einfo " - Extra: $@"
728 useradd -r ${opts} "$@" \
729 ${euser} \
730 || die "enewuser failed"
731 fi
732 ;;
733 esac
734
735 if [[ ! -e ${ROOT}/${ehome} ]] ; then
736 einfo " - Creating ${ehome} in ${ROOT}"
737 mkdir -p "${ROOT}/${ehome}"
738 chown ${euser} "${ROOT}/${ehome}"
739 chmod 755 "${ROOT}/${ehome}"
740 fi
741
742 export SANDBOX_ON=${oldsandbox}
743}
744
745# @FUNCTION: enewgroup
746# @USAGE: <group> [gid]
747# @DESCRIPTION:
748# This function does not require you to understand how to properly add a
749# group to the system. Just give it a group name to add and enewgroup will
750# do the rest. You may specify the gid for the group or allow the group to
751# allocate the next available one.
752enewgroup() {
753 case ${EBUILD_PHASE} in
754 unpack|compile|test|install)
755 eerror "'enewgroup()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
756 eerror "Package fails at QA and at life. Please file a bug."
757 die "Bad package! enewgroup is only for use in pkg_* functions!"
758 esac
759
760 # get the group
761 local egroup="$1"; shift
762 if [ -z "${egroup}" ]
763 then
764 eerror "No group specified !"
765 die "Cannot call enewgroup without a group"
766 fi
767
768 # see if group already exists
769 if [[ -n $(egetent group "${egroup}") ]]; then
770 return 0
771 fi
772 einfo "Adding group '${egroup}' to your system ..."
773
774 # options to pass to useradd
775 local opts=
776
777 # handle gid
778 local egid="$1"; shift
779 if [ ! -z "${egid}" ]
780 then
781 if [ "${egid}" -gt 0 ]
782 then
783 if [ -z "`egetent group ${egid}`" ]
784 then
785 if [[ "${CHOST}" == *-darwin* ]]; then
786 opts="${opts} ${egid}"
787 else
788 opts="${opts} -g ${egid}"
789 fi
790 else
791 egid="next available; requested gid taken"
792 fi
793 else
794 eerror "Groupid given but is not greater than 0 !"
795 die "${egid} is not a valid GID"
796 fi
797 else
798 egid="next available"
799 fi
800 einfo " - Groupid: ${egid}"
801
802 # handle extra
803 local eextra="$@"
804 opts="${opts} ${eextra}"
805
806 # add the group
807 local oldsandbox="${SANDBOX_ON}"
808 export SANDBOX_ON="0"
809 case ${CHOST} in
810 *-darwin*)
811 if [ ! -z "${eextra}" ];
812 then
813 einfo "Extra options are not supported on Darwin/OS X yet"
814 einfo "Please report the ebuild along with the info below"
815 einfo "eextra: ${eextra}"
816 die "Required function missing"
817 fi
818
819 # If we need the next available
820 case ${egid} in
821 *[!0-9]*) # Non numeric
822 for ((egid = 101; egid <= 999; egid++)); do
823 [[ -z $(egetent group ${egid}) ]] && break
824 done
825 esac
826 dscl . create /groups/${egroup} gid ${egid}
827 dscl . create /groups/${egroup} passwd '*'
828 ;;
829
830 *-freebsd*|*-dragonfly*)
831 case ${egid} in
832 *[!0-9]*) # Non numeric
833 for ((egid = 101; egid <= 999; egid++)); do
834 [[ -z $(egetent group ${egid}) ]] && break
835 done
836 esac
837 pw groupadd ${egroup} -g ${egid} || die "enewgroup failed"
838 ;;
839
840 *-netbsd*)
841 case ${egid} in
842 *[!0-9]*) # Non numeric
843 for ((egid = 101; egid <= 999; egid++)); do
844 [[ -z $(egetent group ${egid}) ]] && break
845 done
846 esac
847 groupadd -g ${egid} ${egroup} || die "enewgroup failed"
848 ;;
849
850 *)
851 # We specify -r so that we get a GID in the system range from login.defs
852 groupadd -r ${opts} ${egroup} || die "enewgroup failed"
853 ;;
854 esac
855 export SANDBOX_ON="${oldsandbox}"
856}
857
858# @FUNCTION: edos2unix 602# @FUNCTION: edos2unix
859# @USAGE: <file> [more files ...] 603# @USAGE: <file> [more files ...]
860# @DESCRIPTION: 604# @DESCRIPTION:
861# A handy replacement for dos2unix, recode, fixdos, etc... This allows you 605# A handy replacement for dos2unix, recode, fixdos, etc... This allows you
862# to remove all of these text utilities from DEPEND variables because this 606# to remove all of these text utilities from DEPEND variables because this
863# is a script based solution. Just give it a list of files to convert and 607# is a script based solution. Just give it a list of files to convert and
864# they will all be changed from the DOS CRLF format to the UNIX LF format. 608# they will all be changed from the DOS CRLF format to the UNIX LF format.
865edos2unix() { 609edos2unix() {
866 echo "$@" | xargs sed -i 's/\r$//' 610 [[ $# -eq 0 ]] && return 0
611 sed -i 's/\r$//' -- "$@" || die
867} 612}
868 613
869# Make a desktop file ! 614# Make a desktop file !
870# Great for making those icons in kde/gnome startmenu ! 615# Great for making those icons in kde/gnome startmenu !
871# Amaze your friends ! Get the women ! Join today ! 616# Amaze your friends ! Get the women ! Join today !
1383 dd) exe="dd ibs=${skip} skip=1 if='${src}'";; 1128 dd) exe="dd ibs=${skip} skip=1 if='${src}'";;
1384 *) die "makeself cant handle exe '${exe}'" 1129 *) die "makeself cant handle exe '${exe}'"
1385 esac 1130 esac
1386 1131
1387 # lets grab the first few bytes of the file to figure out what kind of archive it is 1132 # lets grab the first few bytes of the file to figure out what kind of archive it is
1388 local tmpfile=$(emktemp) 1133 local filetype tmpfile=$(emktemp)
1389 eval ${exe} 2>/dev/null | head -c 512 > "${tmpfile}" 1134 eval ${exe} 2>/dev/null | head -c 512 > "${tmpfile}"
1390 local filetype=$(file -b "${tmpfile}") 1135 filetype=$(file -b "${tmpfile}") || die
1391 case ${filetype} in 1136 case ${filetype} in
1392 *tar\ archive*) 1137 *tar\ archive*)
1393 eval ${exe} | tar --no-same-owner -xf - 1138 eval ${exe} | tar --no-same-owner -xf -
1394 ;; 1139 ;;
1395 bzip2*) 1140 bzip2*)
1405 eerror "Unknown filetype \"${filetype}\" ?" 1150 eerror "Unknown filetype \"${filetype}\" ?"
1406 false 1151 false
1407 ;; 1152 ;;
1408 esac 1153 esac
1409 assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})" 1154 assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})"
1410}
1411
1412# @FUNCTION: check_license
1413# @USAGE: [license]
1414# @DESCRIPTION:
1415# Display a license for user to accept. If no license is
1416# specified, then ${LICENSE} is used.
1417check_license() {
1418 local lic=$1
1419 if [ -z "${lic}" ] ; then
1420 lic="${PORTDIR}/licenses/${LICENSE}"
1421 else
1422 if [ -e "${PORTDIR}/licenses/${lic}" ] ; then
1423 lic="${PORTDIR}/licenses/${lic}"
1424 elif [ -e "${PWD}/${lic}" ] ; then
1425 lic="${PWD}/${lic}"
1426 elif [ -e "${lic}" ] ; then
1427 lic="${lic}"
1428 fi
1429 fi
1430 local l="`basename ${lic}`"
1431
1432 # here is where we check for the licenses the user already
1433 # accepted ... if we don't find a match, we make the user accept
1434 local alic
1435 eshopts_push -o noglob # so that bash doesn't expand "*"
1436 for alic in ${ACCEPT_LICENSE} ; do
1437 if [[ ${alic} == ${l} ]]; then
1438 eshopts_pop
1439 return 0
1440 fi
1441 done
1442 eshopts_pop
1443 [ ! -f "${lic}" ] && die "Could not find requested license ${lic}"
1444
1445 local licmsg=$(emktemp)
1446 cat <<-EOF > ${licmsg}
1447 **********************************************************
1448 The following license outlines the terms of use of this
1449 package. You MUST accept this license for installation to
1450 continue. When you are done viewing, hit 'q'. If you
1451 CTRL+C out of this, the install will not run!
1452 **********************************************************
1453
1454 EOF
1455 cat ${lic} >> ${licmsg}
1456 ${PAGER:-less} ${licmsg} || die "Could not execute pager (${PAGER}) to accept ${lic}"
1457 einfon "Do you accept the terms of this license (${l})? [yes/no] "
1458 read alic
1459 case ${alic} in
1460 yes|Yes|y|Y)
1461 return 0
1462 ;;
1463 *)
1464 echo;echo;echo
1465 eerror "You MUST accept the license to continue! Exiting!"
1466 die "Failed to accept license"
1467 ;;
1468 esac
1469} 1155}
1470 1156
1471# @FUNCTION: cdrom_get_cds 1157# @FUNCTION: cdrom_get_cds
1472# @USAGE: <file on cd1> [file on cd2] [file on cd3] [...] 1158# @USAGE: <file on cd1> [file on cd2] [file on cd3] [...]
1473# @DESCRIPTION: 1159# @DESCRIPTION:
1705 else 1391 else
1706 newls="" 1392 newls=""
1707 fi 1393 fi
1708 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do 1394 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do
1709 if [[ ${op} == "-i" ]] ; then 1395 if [[ ${op} == "-i" ]] ; then
1710 hasq ${f} ${ls} && newls="${newls} ${f}" 1396 has ${f} ${ls} && newls="${newls} ${f}"
1711 else 1397 else
1712 hasq ${f} ${ls} || newls="${newls} ${f}" 1398 has ${f} ${ls} || newls="${newls} ${f}"
1713 fi 1399 fi
1714 done 1400 done
1715 ls=${newls} 1401 ls=${newls}
1716 done 1402 done
1717 else 1403 else
1719 fi 1405 fi
1720 1406
1721 nols="" 1407 nols=""
1722 newls="" 1408 newls=""
1723 for f in ${LINGUAS} ; do 1409 for f in ${LINGUAS} ; do
1724 if hasq ${f} ${ls} ; then 1410 if has ${f} ${ls} ; then
1725 newls="${newls} ${f}" 1411 newls="${newls} ${f}"
1726 else 1412 else
1727 nols="${nols} ${f}" 1413 nols="${nols} ${f}"
1728 fi 1414 fi
1729 done 1415 done
1784 ewarn "the libraries are not being removed. You need to run revdep-rebuild" 1470 ewarn "the libraries are not being removed. You need to run revdep-rebuild"
1785 ewarn "in order to remove these old dependencies. If you do not have this" 1471 ewarn "in order to remove these old dependencies. If you do not have this"
1786 ewarn "helper program, simply emerge the 'gentoolkit' package." 1472 ewarn "helper program, simply emerge the 'gentoolkit' package."
1787 ewarn 1473 ewarn
1788 fi 1474 fi
1475 # temp hack for #348634 #357225
1476 [[ ${PN} == "mpfr" ]] && lib=${lib##*/}
1789 ewarn " # revdep-rebuild --library ${lib##*/}" 1477 ewarn " # revdep-rebuild --library '${lib}'"
1790 done 1478 done
1791 if [[ ${notice} -eq 1 ]] ; then 1479 if [[ ${notice} -eq 1 ]] ; then
1792 ewarn 1480 ewarn
1793 ewarn "Once you've finished running revdep-rebuild, it should be safe to" 1481 ewarn "Once you've finished running revdep-rebuild, it should be safe to"
1794 ewarn "delete the old libraries. Here is a copy & paste for the lazy:" 1482 ewarn "delete the old libraries. Here is a copy & paste for the lazy:"
1940 else 1628 else
1941 newbin "${tmpwrapper}" "${wrapper}" || die 1629 newbin "${tmpwrapper}" "${wrapper}" || die
1942 fi 1630 fi
1943} 1631}
1944 1632
1945# @FUNCTION: prepalldocs 1633# @FUNCTION: path_exists
1946# @USAGE: 1634# @USAGE: [-a|-o] <paths>
1947# @DESCRIPTION: 1635# @DESCRIPTION:
1948# Compress files in /usr/share/doc which are not already 1636# Check if the specified paths exist. Works for all types of paths
1949# compressed, excluding /usr/share/doc/${PF}/html. 1637# (files/dirs/etc...). The -a and -o flags control the requirements
1950# Uses the ecompressdir to do the compression. 1638# of the paths. They correspond to "and" and "or" logic. So the -a
1951# 2009-02-18 by betelgeuse: 1639# flag means all the paths must exist while the -o flag means at least
1952# Commented because ecompressdir is even more internal to 1640# one of the paths must exist. The default behavior is "and". If no
1953# Portage than prepalldocs (it's not even mentioned in man 5 1641# paths are specified, then the return value is "false".
1954# ebuild). Please submit a better version for review to gentoo-dev 1642path_exists() {
1955# if you want prepalldocs here. 1643 local opt=$1
1956#prepalldocs() { 1644 [[ ${opt} == -[ao] ]] && shift || opt="-a"
1957# if [[ -n $1 ]] ; then
1958# ewarn "prepalldocs: invalid usage; takes no arguments"
1959# fi
1960 1645
1961# cd "${D}" 1646 # no paths -> return false
1962# [[ -d usr/share/doc ]] || return 0 1647 # same behavior as: [[ -e "" ]]
1648 [[ $# -eq 0 ]] && return 1
1963 1649
1964# find usr/share/doc -exec gzip {} + 1650 local p r=0
1965# ecompressdir --ignore /usr/share/doc/${PF}/html 1651 for p in "$@" ; do
1966# ecompressdir --queue /usr/share/doc 1652 [[ -e ${p} ]]
1967#} 1653 : $(( r += $? ))
1654 done
1655
1656 case ${opt} in
1657 -a) return $(( r != 0 )) ;;
1658 -o) return $(( r == $# )) ;;
1659 esac
1660}
1661
1662# @FUNCTION: in_iuse
1663# @USAGE: <flag>
1664# @DESCRIPTION:
1665# Determines whether the given flag is in IUSE. Strips IUSE default prefixes
1666# as necessary.
1667#
1668# Note that this function should not be used in the global scope.
1669in_iuse() {
1670 debug-print-function ${FUNCNAME} "${@}"
1671 [[ ${#} -eq 1 ]] || die "Invalid args to ${FUNCNAME}()"
1672
1673 local flag=${1}
1674 local liuse=( ${IUSE} )
1675
1676 has "${flag}" "${liuse[@]#[+-]}"
1677}
1678
1679# @FUNCTION: use_if_iuse
1680# @USAGE: <flag>
1681# @DESCRIPTION:
1682# Return true if the given flag is in USE and IUSE.
1683#
1684# Note that this function should not be used in the global scope.
1685use_if_iuse() {
1686 in_iuse $1 || return 1
1687 use $1
1688}
1689
1690# @FUNCTION: usex
1691# @USAGE: <USE flag> [true output] [false output] [true suffix] [false suffix]
1692# @DESCRIPTION:
1693# If USE flag is set, echo [true output][true suffix] (defaults to "yes"),
1694# otherwise echo [false output][false suffix] (defaults to "no").
1695usex() { use "$1" && echo "${2-yes}$4" || echo "${3-no}$5" ; } #382963
1696
1697check_license() { die "you no longer need this as portage supports ACCEPT_LICENSE itself"; }
1698
1699fi

Legend:
Removed from v.1.348  
changed lines
  Added in v.1.373

  ViewVC Help
Powered by ViewVC 1.1.20