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

Diff of /eclass/eutils.eclass

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

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

Legend:
Removed from v.1.12  
changed lines
  Added in v.1.360

  ViewVC Help
Powered by ViewVC 1.1.20