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

Diff of /eclass/eutils.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20