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

Diff of /eclass/eutils.eclass

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

Revision 1.352 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.352 2010/11/22 00:31:03 vapier 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.
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}"}
254 323
324 elif [[ -f ${EPATCH_SOURCE}/$1 ]] ; then
325 # Re-use EPATCH_SOURCE as a search dir
326 epatch "${EPATCH_SOURCE}/$1"
327 return $?
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
259 eerror "Cannot find \$EPATCH_SOURCE! Value for \$EPATCH_SOURCE is:" 333 eerror "Cannot find \$EPATCH_SOURCE! Value for \$EPATCH_SOURCE is:"
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
559 echo "${EPATCH_SOURCE}" > "${applied}"
438 return 0 560 return 0
439 fi 561 fi
440 done 562 done
563 echo "none" > "${applied}"
441 return 1 564 return 1
442} 565}
443 566
444# @FUNCTION: emktemp 567# @FUNCTION: emktemp
445# @USAGE: [temp dir] 568# @USAGE: [temp dir]
474 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX 597 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX
475 fi 598 fi
476 fi 599 fi
477} 600}
478 601
479# @FUNCTION: egetent
480# @USAGE: <database> <key>
481# @MAINTAINER:
482# base-system@gentoo.org (Linux)
483# Joe Jezak <josejx@gmail.com> (OS X)
484# usata@gentoo.org (OS X)
485# Aaron Walker <ka0ttic@gentoo.org> (FreeBSD)
486# @DESCRIPTION:
487# Small wrapper for getent (Linux),
488# nidump (< Mac OS X 10.5), dscl (Mac OS X 10.5),
489# and pw (FreeBSD) used in enewuser()/enewgroup()
490egetent() {
491 case ${CHOST} in
492 *-darwin[678])
493 case "$2" in
494 *[!0-9]*) # Non numeric
495 nidump $1 . | awk -F":" "{ if (\$1 ~ /^$2$/) {print \$0;exit;} }"
496 ;;
497 *) # Numeric
498 nidump $1 . | awk -F":" "{ if (\$3 == $2) {print \$0;exit;} }"
499 ;;
500 esac
501 ;;
502 *-darwin*)
503 local mytype=$1
504 [[ "passwd" == $mytype ]] && mytype="Users"
505 [[ "group" == $mytype ]] && mytype="Groups"
506 case "$2" in
507 *[!0-9]*) # Non numeric
508 dscl . -read /$mytype/$2 2>/dev/null |grep RecordName
509 ;;
510 *) # Numeric
511 local mykey="UniqueID"
512 [[ $mytype == "Groups" ]] && mykey="PrimaryGroupID"
513 dscl . -search /$mytype $mykey $2 2>/dev/null
514 ;;
515 esac
516 ;;
517 *-freebsd*|*-dragonfly*)
518 local opts action="user"
519 [[ $1 == "passwd" ]] || action="group"
520
521 # lookup by uid/gid
522 if [[ $2 == [[:digit:]]* ]] ; then
523 [[ ${action} == "user" ]] && opts="-u" || opts="-g"
524 fi
525
526 pw show ${action} ${opts} "$2" -q
527 ;;
528 *-netbsd*|*-openbsd*)
529 grep "$2:\*:" /etc/$1
530 ;;
531 *)
532 type -p nscd >& /dev/null && nscd -i "$1"
533 getent "$1" "$2"
534 ;;
535 esac
536}
537
538# @FUNCTION: enewuser
539# @USAGE: <user> [uid] [shell] [homedir] [groups] [params]
540# @DESCRIPTION:
541# Same as enewgroup, you are not required to understand how to properly add
542# a user to the system. The only required parameter is the username.
543# Default uid is (pass -1 for this) next available, default shell is
544# /bin/false, default homedir is /dev/null, there are no default groups,
545# and default params sets the comment as 'added by portage for ${PN}'.
546enewuser() {
547 case ${EBUILD_PHASE} in
548 unpack|compile|test|install)
549 eerror "'enewuser()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
550 eerror "Package fails at QA and at life. Please file a bug."
551 die "Bad package! enewuser is only for use in pkg_* functions!"
552 esac
553
554 # get the username
555 local euser=$1; shift
556 if [[ -z ${euser} ]] ; then
557 eerror "No username specified !"
558 die "Cannot call enewuser without a username"
559 fi
560
561 # lets see if the username already exists
562 if [[ -n $(egetent passwd "${euser}") ]] ; then
563 return 0
564 fi
565 einfo "Adding user '${euser}' to your system ..."
566
567 # options to pass to useradd
568 local opts=
569
570 # handle uid
571 local euid=$1; shift
572 if [[ -n ${euid} && ${euid} != -1 ]] ; then
573 if [[ ${euid} -gt 0 ]] ; then
574 if [[ -n $(egetent passwd ${euid}) ]] ; then
575 euid="next"
576 fi
577 else
578 eerror "Userid given but is not greater than 0 !"
579 die "${euid} is not a valid UID"
580 fi
581 else
582 euid="next"
583 fi
584 if [[ ${euid} == "next" ]] ; then
585 for ((euid = 101; euid <= 999; euid++)); do
586 [[ -z $(egetent passwd ${euid}) ]] && break
587 done
588 fi
589 opts="${opts} -u ${euid}"
590 einfo " - Userid: ${euid}"
591
592 # handle shell
593 local eshell=$1; shift
594 if [[ ! -z ${eshell} ]] && [[ ${eshell} != "-1" ]] ; then
595 if [[ ! -e ${ROOT}${eshell} ]] ; then
596 eerror "A shell was specified but it does not exist !"
597 die "${eshell} does not exist in ${ROOT}"
598 fi
599 if [[ ${eshell} == */false || ${eshell} == */nologin ]] ; then
600 eerror "Do not specify ${eshell} yourself, use -1"
601 die "Pass '-1' as the shell parameter"
602 fi
603 else
604 for shell in /sbin/nologin /usr/sbin/nologin /bin/false /usr/bin/false /dev/null ; do
605 [[ -x ${ROOT}${shell} ]] && break
606 done
607
608 if [[ ${shell} == "/dev/null" ]] ; then
609 eerror "Unable to identify the shell to use, proceeding with userland default."
610 case ${USERLAND} in
611 GNU) shell="/bin/false" ;;
612 BSD) shell="/sbin/nologin" ;;
613 Darwin) shell="/usr/sbin/nologin" ;;
614 *) die "Unable to identify the default shell for userland ${USERLAND}"
615 esac
616 fi
617
618 eshell=${shell}
619 fi
620 einfo " - Shell: ${eshell}"
621 opts="${opts} -s ${eshell}"
622
623 # handle homedir
624 local ehome=$1; shift
625 if [[ -z ${ehome} ]] || [[ ${ehome} == "-1" ]] ; then
626 ehome="/dev/null"
627 fi
628 einfo " - Home: ${ehome}"
629 opts="${opts} -d ${ehome}"
630
631 # handle groups
632 local egroups=$1; shift
633 if [[ ! -z ${egroups} ]] ; then
634 local oldifs=${IFS}
635 local defgroup="" exgroups=""
636
637 export IFS=","
638 for g in ${egroups} ; do
639 export IFS=${oldifs}
640 if [[ -z $(egetent group "${g}") ]] ; then
641 eerror "You must add group ${g} to the system first"
642 die "${g} is not a valid GID"
643 fi
644 if [[ -z ${defgroup} ]] ; then
645 defgroup=${g}
646 else
647 exgroups="${exgroups},${g}"
648 fi
649 export IFS=","
650 done
651 export IFS=${oldifs}
652
653 opts="${opts} -g ${defgroup}"
654 if [[ ! -z ${exgroups} ]] ; then
655 opts="${opts} -G ${exgroups:1}"
656 fi
657 else
658 egroups="(none)"
659 fi
660 einfo " - Groups: ${egroups}"
661
662 # handle extra and add the user
663 local oldsandbox=${SANDBOX_ON}
664 export SANDBOX_ON="0"
665 case ${CHOST} in
666 *-darwin*)
667 ### Make the user
668 if [[ -z $@ ]] ; then
669 dscl . create /users/${euser} uid ${euid}
670 dscl . create /users/${euser} shell ${eshell}
671 dscl . create /users/${euser} home ${ehome}
672 dscl . create /users/${euser} realname "added by portage for ${PN}"
673 ### Add the user to the groups specified
674 local oldifs=${IFS}
675 export IFS=","
676 for g in ${egroups} ; do
677 dscl . merge /groups/${g} users ${euser}
678 done
679 export IFS=${oldifs}
680 else
681 einfo "Extra options are not supported on Darwin yet"
682 einfo "Please report the ebuild along with the info below"
683 einfo "eextra: $@"
684 die "Required function missing"
685 fi
686 ;;
687 *-freebsd*|*-dragonfly*)
688 if [[ -z $@ ]] ; then
689 pw useradd ${euser} ${opts} \
690 -c "added by portage for ${PN}" \
691 die "enewuser failed"
692 else
693 einfo " - Extra: $@"
694 pw useradd ${euser} ${opts} \
695 "$@" || die "enewuser failed"
696 fi
697 ;;
698
699 *-netbsd*)
700 if [[ -z $@ ]] ; then
701 useradd ${opts} ${euser} || die "enewuser failed"
702 else
703 einfo " - Extra: $@"
704 useradd ${opts} ${euser} "$@" || die "enewuser failed"
705 fi
706 ;;
707
708 *-openbsd*)
709 if [[ -z $@ ]] ; then
710 useradd -u ${euid} -s ${eshell} \
711 -d ${ehome} -c "Added by portage for ${PN}" \
712 -g ${egroups} ${euser} || die "enewuser failed"
713 else
714 einfo " - Extra: $@"
715 useradd -u ${euid} -s ${eshell} \
716 -d ${ehome} -c "Added by portage for ${PN}" \
717 -g ${egroups} ${euser} "$@" || die "enewuser failed"
718 fi
719 ;;
720
721 *)
722 if [[ -z $@ ]] ; then
723 useradd -r ${opts} \
724 -c "added by portage for ${PN}" \
725 ${euser} \
726 || die "enewuser failed"
727 else
728 einfo " - Extra: $@"
729 useradd -r ${opts} "$@" \
730 ${euser} \
731 || die "enewuser failed"
732 fi
733 ;;
734 esac
735
736 if [[ ! -e ${ROOT}/${ehome} ]] ; then
737 einfo " - Creating ${ehome} in ${ROOT}"
738 mkdir -p "${ROOT}/${ehome}"
739 chown ${euser} "${ROOT}/${ehome}"
740 chmod 755 "${ROOT}/${ehome}"
741 fi
742
743 export SANDBOX_ON=${oldsandbox}
744}
745
746# @FUNCTION: enewgroup
747# @USAGE: <group> [gid]
748# @DESCRIPTION:
749# This function does not require you to understand how to properly add a
750# group to the system. Just give it a group name to add and enewgroup will
751# do the rest. You may specify the gid for the group or allow the group to
752# allocate the next available one.
753enewgroup() {
754 case ${EBUILD_PHASE} in
755 unpack|compile|test|install)
756 eerror "'enewgroup()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
757 eerror "Package fails at QA and at life. Please file a bug."
758 die "Bad package! enewgroup is only for use in pkg_* functions!"
759 esac
760
761 # get the group
762 local egroup="$1"; shift
763 if [ -z "${egroup}" ]
764 then
765 eerror "No group specified !"
766 die "Cannot call enewgroup without a group"
767 fi
768
769 # see if group already exists
770 if [[ -n $(egetent group "${egroup}") ]]; then
771 return 0
772 fi
773 einfo "Adding group '${egroup}' to your system ..."
774
775 # options to pass to useradd
776 local opts=
777
778 # handle gid
779 local egid="$1"; shift
780 if [ ! -z "${egid}" ]
781 then
782 if [ "${egid}" -gt 0 ]
783 then
784 if [ -z "`egetent group ${egid}`" ]
785 then
786 if [[ "${CHOST}" == *-darwin* ]]; then
787 opts="${opts} ${egid}"
788 else
789 opts="${opts} -g ${egid}"
790 fi
791 else
792 egid="next available; requested gid taken"
793 fi
794 else
795 eerror "Groupid given but is not greater than 0 !"
796 die "${egid} is not a valid GID"
797 fi
798 else
799 egid="next available"
800 fi
801 einfo " - Groupid: ${egid}"
802
803 # handle extra
804 local eextra="$@"
805 opts="${opts} ${eextra}"
806
807 # add the group
808 local oldsandbox="${SANDBOX_ON}"
809 export SANDBOX_ON="0"
810 case ${CHOST} in
811 *-darwin*)
812 if [ ! -z "${eextra}" ];
813 then
814 einfo "Extra options are not supported on Darwin/OS X yet"
815 einfo "Please report the ebuild along with the info below"
816 einfo "eextra: ${eextra}"
817 die "Required function missing"
818 fi
819
820 # If we need the next available
821 case ${egid} in
822 *[!0-9]*) # Non numeric
823 for ((egid = 101; egid <= 999; egid++)); do
824 [[ -z $(egetent group ${egid}) ]] && break
825 done
826 esac
827 dscl . create /groups/${egroup} gid ${egid}
828 dscl . create /groups/${egroup} passwd '*'
829 ;;
830
831 *-freebsd*|*-dragonfly*)
832 case ${egid} in
833 *[!0-9]*) # Non numeric
834 for ((egid = 101; egid <= 999; egid++)); do
835 [[ -z $(egetent group ${egid}) ]] && break
836 done
837 esac
838 pw groupadd ${egroup} -g ${egid} || die "enewgroup failed"
839 ;;
840
841 *-netbsd*)
842 case ${egid} in
843 *[!0-9]*) # Non numeric
844 for ((egid = 101; egid <= 999; egid++)); do
845 [[ -z $(egetent group ${egid}) ]] && break
846 done
847 esac
848 groupadd -g ${egid} ${egroup} || die "enewgroup failed"
849 ;;
850
851 *)
852 # We specify -r so that we get a GID in the system range from login.defs
853 groupadd -r ${opts} ${egroup} || die "enewgroup failed"
854 ;;
855 esac
856 export SANDBOX_ON="${oldsandbox}"
857}
858
859# @FUNCTION: edos2unix 602# @FUNCTION: edos2unix
860# @USAGE: <file> [more files ...] 603# @USAGE: <file> [more files ...]
861# @DESCRIPTION: 604# @DESCRIPTION:
862# A handy replacement for dos2unix, recode, fixdos, etc... This allows you 605# A handy replacement for dos2unix, recode, fixdos, etc... This allows you
863# 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
864# 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
865# 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.
866edos2unix() { 609edos2unix() {
867 echo "$@" | xargs sed -i 's/\r$//' 610 [[ $# -eq 0 ]] && return 0
611 sed -i 's/\r$//' -- "$@" || die
868} 612}
869 613
870# Make a desktop file ! 614# Make a desktop file !
871# Great for making those icons in kde/gnome startmenu ! 615# Great for making those icons in kde/gnome startmenu !
872# Amaze your friends ! Get the women ! Join today ! 616# Amaze your friends ! Get the women ! Join today !
1384 dd) exe="dd ibs=${skip} skip=1 if='${src}'";; 1128 dd) exe="dd ibs=${skip} skip=1 if='${src}'";;
1385 *) die "makeself cant handle exe '${exe}'" 1129 *) die "makeself cant handle exe '${exe}'"
1386 esac 1130 esac
1387 1131
1388 # 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
1389 local tmpfile=$(emktemp) 1133 local filetype tmpfile=$(emktemp)
1390 eval ${exe} 2>/dev/null | head -c 512 > "${tmpfile}" 1134 eval ${exe} 2>/dev/null | head -c 512 > "${tmpfile}"
1391 local filetype=$(file -b "${tmpfile}") 1135 filetype=$(file -b "${tmpfile}") || die
1392 case ${filetype} in 1136 case ${filetype} in
1393 *tar\ archive*) 1137 *tar\ archive*)
1394 eval ${exe} | tar --no-same-owner -xf - 1138 eval ${exe} | tar --no-same-owner -xf -
1395 ;; 1139 ;;
1396 bzip2*) 1140 bzip2*)
1406 eerror "Unknown filetype \"${filetype}\" ?" 1150 eerror "Unknown filetype \"${filetype}\" ?"
1407 false 1151 false
1408 ;; 1152 ;;
1409 esac 1153 esac
1410 assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})" 1154 assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})"
1411}
1412
1413# @FUNCTION: check_license
1414# @USAGE: [license]
1415# @DESCRIPTION:
1416# Display a license for user to accept. If no license is
1417# specified, then ${LICENSE} is used.
1418check_license() {
1419 local lic=$1
1420 if [ -z "${lic}" ] ; then
1421 lic="${PORTDIR}/licenses/${LICENSE}"
1422 else
1423 if [ -e "${PORTDIR}/licenses/${lic}" ] ; then
1424 lic="${PORTDIR}/licenses/${lic}"
1425 elif [ -e "${PWD}/${lic}" ] ; then
1426 lic="${PWD}/${lic}"
1427 elif [ -e "${lic}" ] ; then
1428 lic="${lic}"
1429 fi
1430 fi
1431 local l="`basename ${lic}`"
1432
1433 # here is where we check for the licenses the user already
1434 # accepted ... if we don't find a match, we make the user accept
1435 local alic
1436 eshopts_push -o noglob # so that bash doesn't expand "*"
1437 for alic in ${ACCEPT_LICENSE} ; do
1438 if [[ ${alic} == ${l} ]]; then
1439 eshopts_pop
1440 return 0
1441 fi
1442 done
1443 eshopts_pop
1444 [ ! -f "${lic}" ] && die "Could not find requested license ${lic}"
1445
1446 local licmsg=$(emktemp)
1447 cat <<-EOF > ${licmsg}
1448 **********************************************************
1449 The following license outlines the terms of use of this
1450 package. You MUST accept this license for installation to
1451 continue. When you are done viewing, hit 'q'. If you
1452 CTRL+C out of this, the install will not run!
1453 **********************************************************
1454
1455 EOF
1456 cat ${lic} >> ${licmsg}
1457 ${PAGER:-less} ${licmsg} || die "Could not execute pager (${PAGER}) to accept ${lic}"
1458 einfon "Do you accept the terms of this license (${l})? [yes/no] "
1459 read alic
1460 case ${alic} in
1461 yes|Yes|y|Y)
1462 return 0
1463 ;;
1464 *)
1465 echo;echo;echo
1466 eerror "You MUST accept the license to continue! Exiting!"
1467 die "Failed to accept license"
1468 ;;
1469 esac
1470} 1155}
1471 1156
1472# @FUNCTION: cdrom_get_cds 1157# @FUNCTION: cdrom_get_cds
1473# @USAGE: <file on cd1> [file on cd2] [file on cd3] [...] 1158# @USAGE: <file on cd1> [file on cd2] [file on cd3] [...]
1474# @DESCRIPTION: 1159# @DESCRIPTION:
1706 else 1391 else
1707 newls="" 1392 newls=""
1708 fi 1393 fi
1709 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do 1394 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do
1710 if [[ ${op} == "-i" ]] ; then 1395 if [[ ${op} == "-i" ]] ; then
1711 hasq ${f} ${ls} && newls="${newls} ${f}" 1396 has ${f} ${ls} && newls="${newls} ${f}"
1712 else 1397 else
1713 hasq ${f} ${ls} || newls="${newls} ${f}" 1398 has ${f} ${ls} || newls="${newls} ${f}"
1714 fi 1399 fi
1715 done 1400 done
1716 ls=${newls} 1401 ls=${newls}
1717 done 1402 done
1718 else 1403 else
1720 fi 1405 fi
1721 1406
1722 nols="" 1407 nols=""
1723 newls="" 1408 newls=""
1724 for f in ${LINGUAS} ; do 1409 for f in ${LINGUAS} ; do
1725 if hasq ${f} ${ls} ; then 1410 if has ${f} ${ls} ; then
1726 newls="${newls} ${f}" 1411 newls="${newls} ${f}"
1727 else 1412 else
1728 nols="${nols} ${f}" 1413 nols="${nols} ${f}"
1729 fi 1414 fi
1730 done 1415 done
1785 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"
1786 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"
1787 ewarn "helper program, simply emerge the 'gentoolkit' package." 1472 ewarn "helper program, simply emerge the 'gentoolkit' package."
1788 ewarn 1473 ewarn
1789 fi 1474 fi
1475 # temp hack for #348634 #357225
1476 [[ ${PN} == "mpfr" ]] && lib=${lib##*/}
1790 ewarn " # revdep-rebuild --library '${lib}'" 1477 ewarn " # revdep-rebuild --library '${lib}'"
1791 done 1478 done
1792 if [[ ${notice} -eq 1 ]] ; then 1479 if [[ ${notice} -eq 1 ]] ; then
1793 ewarn 1480 ewarn
1794 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"
1941 else 1628 else
1942 newbin "${tmpwrapper}" "${wrapper}" || die 1629 newbin "${tmpwrapper}" "${wrapper}" || die
1943 fi 1630 fi
1944} 1631}
1945 1632
1946# @FUNCTION: prepalldocs
1947# @USAGE:
1948# @DESCRIPTION:
1949# Compress files in /usr/share/doc which are not already
1950# compressed, excluding /usr/share/doc/${PF}/html.
1951# Uses the ecompressdir to do the compression.
1952# 2009-02-18 by betelgeuse:
1953# Commented because ecompressdir is even more internal to
1954# Portage than prepalldocs (it's not even mentioned in man 5
1955# ebuild). Please submit a better version for review to gentoo-dev
1956# if you want prepalldocs here.
1957#prepalldocs() {
1958# if [[ -n $1 ]] ; then
1959# ewarn "prepalldocs: invalid usage; takes no arguments"
1960# fi
1961
1962# cd "${D}"
1963# [[ -d usr/share/doc ]] || return 0
1964
1965# find usr/share/doc -exec gzip {} +
1966# ecompressdir --ignore /usr/share/doc/${PF}/html
1967# ecompressdir --queue /usr/share/doc
1968#}
1969
1970# @FUNCTION: path_exists 1633# @FUNCTION: path_exists
1971# @USAGE: [-a|-o] <paths> 1634# @USAGE: [-a|-o] <paths>
1972# @DESCRIPTION: 1635# @DESCRIPTION:
1973# Check if the specified paths exist. Works for all types of paths 1636# Check if the specified paths exist. Works for all types of paths
1974# (files/dirs/etc...). The -a and -o flags control the requirements 1637# (files/dirs/etc...). The -a and -o flags control the requirements
1993 case ${opt} in 1656 case ${opt} in
1994 -a) return $(( r != 0 )) ;; 1657 -a) return $(( r != 0 )) ;;
1995 -o) return $(( r == $# )) ;; 1658 -o) return $(( r == $# )) ;;
1996 esac 1659 esac
1997} 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.352  
changed lines
  Added in v.1.373

  ViewVC Help
Powered by ViewVC 1.1.20