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

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

  ViewVC Help
Powered by ViewVC 1.1.20