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

Diff of /eclass/eutils.eclass

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

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

Legend:
Removed from v.1.41  
changed lines
  Added in v.1.372

  ViewVC Help
Powered by ViewVC 1.1.20