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

Diff of /eclass/eutils.eclass

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

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

Legend:
Removed from v.1.71  
changed lines
  Added in v.1.381

  ViewVC Help
Powered by ViewVC 1.1.20