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

Contents of /eclass/eutils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.384 - (hide annotations) (download)
Sun Feb 26 13:20:59 2012 UTC (2 years, 4 months ago) by pacho
Branch: MAIN
Changes since 1.383: +13 -13 lines
Use correct menu categories for app-* as discussed in gentoo-dev.

1 ulm 1.378 # Copyright 1999-2012 Gentoo Foundation
2 azarah 1.1 # Distributed under the terms of the GNU General Public License v2
3 pacho 1.384 # $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.383 2012/02/16 00:27:17 vapier Exp $
4 vapier 1.283
5     # @ECLASS: eutils.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 swegener 1.286 #
15 vapier 1.283 # Due to the nature of this eclass, some functions may have maintainers
16     # different from the overall eclass!
17 azarah 1.1
18 vapier 1.371 if [[ ${___ECLASS_ONCE_EUTILS} != "recur -_+^+_- spank" ]] ; then
19     ___ECLASS_ONCE_EUTILS="recur -_+^+_- spank"
20    
21 ulm 1.380 inherit multilib portability user
22 azarah 1.1
23 vapier 1.22 DESCRIPTION="Based on the ${ECLASS} eclass"
24 azarah 1.1
25 betelgeuse 1.329 if has "${EAPI:-0}" 0 1 2; then
26    
27 vapier 1.283 # @FUNCTION: epause
28     # @USAGE: [seconds]
29     # @DESCRIPTION:
30     # Sleep for the specified number of seconds (default of 5 seconds). Useful when
31     # printing a message the user should probably be reading and often used in
32     # conjunction with the ebeep function. If the EPAUSE_IGNORE env var is set,
33 betelgeuse 1.329 # don't wait at all. Defined in EAPIs 0 1 and 2.
34 ciaranm 1.98 epause() {
35 vapier 1.245 [[ -z ${EPAUSE_IGNORE} ]] && sleep ${1:-5}
36 ciaranm 1.98 }
37    
38 vapier 1.283 # @FUNCTION: ebeep
39     # @USAGE: [number of beeps]
40     # @DESCRIPTION:
41     # Issue the specified number of beeps (default of 5 beeps). Useful when
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 betelgeuse 1.329 # don't beep at all. Defined in EAPIs 0 1 and 2.
45 ciaranm 1.98 ebeep() {
46     local n
47 vapier 1.245 if [[ -z ${EBEEP_IGNORE} ]] ; then
48 ciaranm 1.98 for ((n=1 ; n <= ${1:-5} ; n++)) ; do
49     echo -ne "\a"
50     sleep 0.1 &>/dev/null ; sleep 0,1 &>/dev/null
51     echo -ne "\a"
52     sleep 1
53     done
54     fi
55     }
56    
57 reavertm 1.331 else
58    
59 reavertm 1.332 ebeep() {
60 reavertm 1.337 ewarn "QA Notice: ebeep is not defined in EAPI=${EAPI}, please file a bug at http://bugs.gentoo.org"
61 reavertm 1.332 }
62 reavertm 1.331
63 reavertm 1.332 epause() {
64 reavertm 1.337 ewarn "QA Notice: epause is not defined in EAPI=${EAPI}, please file a bug at http://bugs.gentoo.org"
65 reavertm 1.332 }
66 reavertm 1.331
67 betelgeuse 1.329 fi
68    
69 betelgeuse 1.348 # @FUNCTION: eqawarn
70     # @USAGE: [message]
71     # @DESCRIPTION:
72 mgorny 1.363 # 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.
75 betelgeuse 1.348 if ! declare -F eqawarn >/dev/null ; then
76     eqawarn() {
77 mgorny 1.363 has qa ${PORTAGE_ELOG_CLASSES} && ewarn "$@"
78 ferringb 1.370 :
79 betelgeuse 1.348 }
80     fi
81    
82 hollow 1.298 # @FUNCTION: ecvs_clean
83 vapier 1.299 # @USAGE: [list of dirs]
84 hollow 1.298 # @DESCRIPTION:
85 vapier 1.299 # Remove CVS directories recursiveley. Useful when a source tarball contains
86     # internal CVS directories. Defaults to $PWD.
87 hollow 1.298 ecvs_clean() {
88 vapier 1.299 [[ -z $* ]] && set -- .
89 hollow 1.298 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 vapier 1.299 # @USAGE: [list of dirs]
95 hollow 1.298 # @DESCRIPTION:
96 vapier 1.299 # Remove .svn directories recursiveley. Useful when a source tarball contains
97     # internal Subversion directories. Defaults to $PWD.
98 hollow 1.298 esvn_clean() {
99 vapier 1.299 [[ -z $* ]] && set -- .
100 hollow 1.298 find "$@" -type d -name '.svn' -prune -print0 | xargs -0 rm -rf
101     }
102    
103 vapier 1.373 # @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
117     estack_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.
129     estack_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 vapier 1.376 eval local __estack_i=\${#${__estack_name}\[@\]}
141 vapier 1.373 # 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 vapier 1.376 eval ${__estack_retvar}=\"\${${__estack_name}\[${__estack_i}\]}\"
147 vapier 1.373 fi
148 vapier 1.376 eval unset ${__estack_name}\[${__estack_i}\]
149 vapier 1.373 }
150    
151 vapier 1.322 # @FUNCTION: eshopts_push
152 vapier 1.330 # @USAGE: [options to `set` or `shopt`]
153 vapier 1.322 # @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 vapier 1.330 # 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 vapier 1.322 # 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 vapier 1.376 # eshopts_push -s noglob
166 vapier 1.322 # for x in ${foo} ; do
167     # if ...some check... ; then
168     # eshopts_pop
169     # return 0
170     # fi
171     # done
172     # eshopts_pop
173     # @CODE
174     eshopts_push() {
175 vapier 1.330 if [[ $1 == -[su] ]] ; then
176 vapier 1.376 estack_push eshopts "$(shopt -p)"
177 vapier 1.330 [[ $# -eq 0 ]] && return 0
178 vapier 1.375 shopt "$@" || die "${FUNCNAME}: bad options to shopt: $*"
179 vapier 1.330 else
180 vapier 1.376 estack_push eshopts $-
181 vapier 1.330 [[ $# -eq 0 ]] && return 0
182 vapier 1.375 set "$@" || die "${FUNCNAME}: bad options to set: $*"
183 vapier 1.330 fi
184 vapier 1.322 }
185    
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.
191     eshopts_pop() {
192 vapier 1.376 local s
193     estack_pop eshopts s || die "${FUNCNAME}: unbalanced push"
194 vapier 1.330 if [[ ${s} == "shopt -"* ]] ; then
195 vapier 1.375 eval "${s}" || die "${FUNCNAME}: sanity: invalid shopt options: ${s}"
196 vapier 1.330 else
197 vapier 1.375 set +$- || die "${FUNCNAME}: sanity: invalid shell settings: $-"
198     set -${s} || die "${FUNCNAME}: sanity: unable to restore saved shell settings: ${s}"
199 vapier 1.330 fi
200 vapier 1.322 }
201    
202 vapier 1.373 # @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.
207     eumask_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.
216     eumask_pop() {
217 vapier 1.382 [[ $# -eq 0 ]] || die "${FUNCNAME}: we take no options"
218 vapier 1.373 local s
219     estack_pop eumask s || die "${FUNCNAME}: unbalanced push"
220     umask ${s} || die "${FUNCNAME}: sanity: could not restore umask: ${s}"
221     }
222    
223 vapier 1.325 # @VARIABLE: EPATCH_SOURCE
224     # @DESCRIPTION:
225     # Default directory to search for patches.
226 azarah 1.2 EPATCH_SOURCE="${WORKDIR}/patch"
227 vapier 1.325 # @VARIABLE: EPATCH_SUFFIX
228     # @DESCRIPTION:
229     # Default extension for patches (do not prefix the period yourself).
230 azarah 1.2 EPATCH_SUFFIX="patch.bz2"
231 vapier 1.325 # @VARIABLE: EPATCH_OPTS
232     # @DESCRIPTION:
233     # Default options for patch:
234     # @CODE
235     # -g0 - keep RCS, ClearCase, Perforce and SCCS happy #24571
236     # --no-backup-if-mismatch - do not leave .orig files behind
237     # -E - automatically remove empty files
238     # @CODE
239 vapier 1.230 EPATCH_OPTS="-g0 -E --no-backup-if-mismatch"
240 vapier 1.325 # @VARIABLE: EPATCH_EXCLUDE
241     # @DESCRIPTION:
242 mr_bones_ 1.308 # List of patches not to apply. Note this is only file names,
243 vapier 1.325 # and not the full path. Globs accepted.
244 azarah 1.6 EPATCH_EXCLUDE=""
245 vapier 1.325 # @VARIABLE: EPATCH_SINGLE_MSG
246     # @DESCRIPTION:
247 azarah 1.9 # Change the printed message for a single patch.
248     EPATCH_SINGLE_MSG=""
249 vapier 1.325 # @VARIABLE: EPATCH_MULTI_MSG
250     # @DESCRIPTION:
251 vapier 1.173 # Change the printed message for multiple patches.
252     EPATCH_MULTI_MSG="Applying various patches (bugfixes/updates) ..."
253 vapier 1.325 # @VARIABLE: EPATCH_FORCE
254     # @DESCRIPTION:
255     # Only require patches to match EPATCH_SUFFIX rather than the extended
256     # arch naming style.
257 azarah 1.29 EPATCH_FORCE="no"
258 azarah 1.2
259 vapier 1.325 # @FUNCTION: epatch
260     # @USAGE: [patches] [dirs of patches]
261     # @DESCRIPTION:
262     # epatch is designed to greatly simplify the application of patches. It can
263     # process patch files directly, or directories of patches. The patches may be
264     # compressed (bzip/gzip/etc...) or plain text. You generally need not specify
265     # the -p option as epatch will automatically attempt -p0 to -p5 until things
266     # apply successfully.
267 azarah 1.2 #
268 vapier 1.325 # If you do not specify any options, then epatch will default to the directory
269     # specified by EPATCH_SOURCE.
270 azarah 1.2 #
271 vapier 1.325 # When processing directories, epatch will apply all patches that match:
272     # @CODE
273 vapier 1.350 # if ${EPATCH_FORCE} != "yes"
274 vapier 1.325 # ??_${ARCH}_foo.${EPATCH_SUFFIX}
275     # else
276     # *.${EPATCH_SUFFIX}
277     # @CODE
278     # The leading ?? are typically numbers used to force consistent patch ordering.
279     # The arch field is used to apply patches only for the host architecture with
280     # the special value of "all" means apply for everyone. Note that using values
281     # other than "all" is highly discouraged -- you should apply patches all the
282     # time and let architecture details be detected at configure/compile time.
283 azarah 1.2 #
284 vapier 1.325 # If EPATCH_SUFFIX is empty, then no period before it is implied when searching
285     # for patches to apply.
286 azarah 1.2 #
287 vapier 1.325 # Refer to the other EPATCH_xxx variables for more customization of behavior.
288 azarah 1.2 epatch() {
289 swegener 1.231 _epatch_draw_line() {
290 vapier 1.325 # create a line of same length as input string
291 agriffis 1.229 [[ -z $1 ]] && set "$(printf "%65s" '')"
292     echo "${1//?/=}"
293 vapier 1.219 }
294 azarah 1.3
295 vapier 1.195 unset P4CONFIG P4PORT P4USER # keep perforce at bay #56402
296    
297 vapier 1.325 # Let the rest of the code process one user arg at a time --
298     # each arg may expand into multiple patches, and each arg may
299     # need to start off with the default global EPATCH_xxx values
300     if [[ $# -gt 1 ]] ; then
301     local m
302 vapier 1.94 for m in "$@" ; do
303     epatch "${m}"
304     done
305     return 0
306 azarah 1.3 fi
307    
308 vapier 1.325 local SINGLE_PATCH="no"
309     # no args means process ${EPATCH_SOURCE}
310     [[ $# -eq 0 ]] && set -- "${EPATCH_SOURCE}"
311    
312     if [[ -f $1 ]] ; then
313 azarah 1.3 SINGLE_PATCH="yes"
314 vapier 1.325 set -- "$1"
315     # Use the suffix from the single patch (localize it); the code
316     # below will find the suffix for us
317     local EPATCH_SUFFIX=$1
318    
319     elif [[ -d $1 ]] ; then
320     # Some people like to make dirs of patches w/out suffixes (vim)
321     set -- "$1"/*${EPATCH_SUFFIX:+."${EPATCH_SUFFIX}"}
322 danarmak 1.32
323 vapier 1.359 elif [[ -f ${EPATCH_SOURCE}/$1 ]] ; then
324     # Re-use EPATCH_SOURCE as a search dir
325     epatch "${EPATCH_SOURCE}/$1"
326     return $?
327    
328 azarah 1.3 else
329 vapier 1.325 # sanity check ... if it isn't a dir or file, wtf man ?
330     [[ $# -ne 0 ]] && EPATCH_SOURCE=$1
331     echo
332     eerror "Cannot find \$EPATCH_SOURCE! Value for \$EPATCH_SOURCE is:"
333     eerror
334     eerror " ${EPATCH_SOURCE}"
335     eerror " ( ${EPATCH_SOURCE##*/} )"
336     echo
337     die "Cannot find \$EPATCH_SOURCE!"
338 azarah 1.3 fi
339 azarah 1.2
340 vapier 1.325 local PIPE_CMD
341 azarah 1.2 case ${EPATCH_SUFFIX##*\.} in
342 vapier 1.325 xz) PIPE_CMD="xz -dc" ;;
343     lzma) PIPE_CMD="lzma -dc" ;;
344     bz2) PIPE_CMD="bzip2 -dc" ;;
345     gz|Z|z) PIPE_CMD="gzip -dc" ;;
346     ZIP|zip) PIPE_CMD="unzip -p" ;;
347     *) ;;
348 azarah 1.2 esac
349    
350 vapier 1.325 [[ ${SINGLE_PATCH} == "no" ]] && einfo "${EPATCH_MULTI_MSG}"
351    
352     local x
353     for x in "$@" ; do
354     # If the patch dir given contains subdirs, or our EPATCH_SUFFIX
355     # didn't match anything, ignore continue on
356     [[ ! -f ${x} ]] && continue
357    
358     local patchname=${x##*/}
359    
360     # Apply single patches, or forced sets of patches, or
361     # patches with ARCH dependant names.
362 flameeyes 1.266 # ???_arch_foo.patch
363 vapier 1.325 # Else, skip this input altogether
364     local a=${patchname#*_} # strip the ???_
365     a=${a%%_*} # strip the _foo.patch
366     if ! [[ ${SINGLE_PATCH} == "yes" || \
367 ulm 1.354 ${EPATCH_FORCE} == "yes" || \
368     ${a} == all || \
369     ${a} == ${ARCH} ]]
370 azarah 1.2 then
371 vapier 1.325 continue
372     fi
373 azarah 1.6
374 vapier 1.325 # Let people filter things dynamically
375     if [[ -n ${EPATCH_EXCLUDE} ]] ; then
376     # let people use globs in the exclude
377     eshopts_push -o noglob
378    
379 scarabeus 1.328 local ex
380 vapier 1.325 for ex in ${EPATCH_EXCLUDE} ; do
381 scarabeus 1.328 if [[ ${patchname} == ${ex} ]] ; then
382     eshopts_pop
383     continue 2
384     fi
385 vapier 1.325 done
386 vapier 1.326
387 vapier 1.325 eshopts_pop
388     fi
389 danarmak 1.32
390 vapier 1.325 if [[ ${SINGLE_PATCH} == "yes" ]] ; then
391     if [[ -n ${EPATCH_SINGLE_MSG} ]] ; then
392     einfo "${EPATCH_SINGLE_MSG}"
393 azarah 1.3 else
394 vapier 1.325 einfo "Applying ${patchname} ..."
395 azarah 1.3 fi
396 vapier 1.325 else
397     einfo " ${patchname} ..."
398     fi
399 azarah 1.2
400 vapier 1.325 # most of the time, there will only be one run per unique name,
401     # but if there are more, make sure we get unique log filenames
402     local STDERR_TARGET="${T}/${patchname}.out"
403     if [[ -e ${STDERR_TARGET} ]] ; then
404     STDERR_TARGET="${T}/${patchname}-$$.out"
405     fi
406 azarah 1.2
407 vapier 1.369 printf "***** %s *****\nPWD: %s\n\n" "${patchname}" "${PWD}" > "${STDERR_TARGET}"
408 vapier 1.304
409 vapier 1.325 # Decompress the patch if need be
410     local count=0
411     local PATCH_TARGET
412     if [[ -n ${PIPE_CMD} ]] ; then
413     PATCH_TARGET="${T}/$$.patch"
414     echo "PIPE_COMMAND: ${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> "${STDERR_TARGET}"
415 vapier 1.304
416 vapier 1.325 if ! (${PIPE_CMD} "${x}" > "${PATCH_TARGET}") >> "${STDERR_TARGET}" 2>&1 ; then
417     echo
418     eerror "Could not extract patch!"
419     #die "Could not extract patch!"
420     count=5
421     break
422 vapier 1.305 fi
423 vapier 1.325 else
424     PATCH_TARGET=${x}
425     fi
426 vapier 1.305
427 vapier 1.325 # Check for absolute paths in patches. If sandbox is disabled,
428     # people could (accidently) patch files in the root filesystem.
429     # Or trigger other unpleasantries #237667. So disallow -p0 on
430     # such patches.
431     local abs_paths=$(egrep -n '^[-+]{3} /' "${PATCH_TARGET}" | awk '$2 != "/dev/null" { print }')
432     if [[ -n ${abs_paths} ]] ; then
433     count=1
434     printf "NOTE: skipping -p0 due to absolute paths in patch:\n%s\n" "${abs_paths}" >> "${STDERR_TARGET}"
435     fi
436 vapier 1.353 # Similar reason, but with relative paths.
437     local rel_paths=$(egrep -n '^[-+]{3} [^ ]*[.][.]/' "${PATCH_TARGET}")
438     if [[ -n ${rel_paths} ]] ; then
439     eqawarn "QA Notice: Your patch uses relative paths '../'."
440     eqawarn " In the future this will cause a failure."
441     eqawarn "${rel_paths}"
442     fi
443 vapier 1.325
444     # Dynamically detect the correct -p# ... i'm lazy, so shoot me :/
445 vapier 1.383 local patch_cmd
446 vapier 1.325 while [[ ${count} -lt 5 ]] ; do
447 vapier 1.383 patch_cmd="patch -p${count} ${EPATCH_OPTS}"
448    
449 vapier 1.325 # Generate some useful debug info ...
450     (
451     _epatch_draw_line "***** ${patchname} *****"
452     echo
453 vapier 1.383 echo "PATCH COMMAND: ${patch_cmd} < '${PATCH_TARGET}'"
454 vapier 1.325 echo
455     _epatch_draw_line "***** ${patchname} *****"
456 vapier 1.383 ${patch_cmd} --dry-run -f < "${PATCH_TARGET}" 2>&1
457 vapier 1.360 ret=$?
458     echo
459     echo "patch program exited with status ${ret}"
460     exit ${ret}
461 vapier 1.325 ) >> "${STDERR_TARGET}"
462 azarah 1.8
463 vapier 1.360 if [ $? -eq 0 ] ; then
464 vapier 1.325 (
465     _epatch_draw_line "***** ${patchname} *****"
466     echo
467     echo "ACTUALLY APPLYING ${patchname} ..."
468     echo
469     _epatch_draw_line "***** ${patchname} *****"
470 vapier 1.383 ${patch_cmd} < "${PATCH_TARGET}" 2>&1
471 vapier 1.360 ret=$?
472     echo
473     echo "patch program exited with status ${ret}"
474     exit ${ret}
475 vapier 1.325 ) >> "${STDERR_TARGET}"
476 danarmak 1.32
477 vapier 1.325 if [ $? -ne 0 ] ; then
478     echo
479     eerror "A dry-run of patch command succeeded, but actually"
480     eerror "applying the patch failed!"
481     #die "Real world sux compared to the dreamworld!"
482     count=5
483 azarah 1.2 fi
484 vapier 1.325 break
485 azarah 1.8 fi
486    
487 vapier 1.325 : $(( count++ ))
488     done
489 azarah 1.8
490 vapier 1.325 # if we had to decompress the patch, delete the temp one
491     if [[ -n ${PIPE_CMD} ]] ; then
492     rm -f "${PATCH_TARGET}"
493     fi
494 azarah 1.3
495 vapier 1.325 if [[ ${count} -ge 5 ]] ; then
496     echo
497     eerror "Failed Patch: ${patchname} !"
498     eerror " ( ${PATCH_TARGET} )"
499     eerror
500     eerror "Include in your bugreport the contents of:"
501     eerror
502     eerror " ${STDERR_TARGET}"
503     echo
504     die "Failed Patch: ${patchname}!"
505 azarah 1.2 fi
506 vapier 1.325
507 vapier 1.383 # if everything worked, delete the full debug patch log
508 vapier 1.325 rm -f "${STDERR_TARGET}"
509 vapier 1.383
510     # then log away the exact stuff for people to review later
511     cat <<-EOF >> "${T}/epatch.log"
512     PATCH: ${x}
513     CMD: ${patch_cmd}
514     PWD: ${PWD}
515    
516     EOF
517 vapier 1.325 eend 0
518 azarah 1.2 done
519 vapier 1.325
520     [[ ${SINGLE_PATCH} == "no" ]] && einfo "Done with patching"
521     : # everything worked
522 azarah 1.26 }
523 vapier 1.361
524     # @FUNCTION: epatch_user
525     # @USAGE:
526     # @DESCRIPTION:
527     # Applies user-provided patches to the source tree. The patches are
528     # taken from /etc/portage/patches/<CATEGORY>/<PF|P|PN>/, where the first
529     # of these three directories to exist will be the one to use, ignoring
530     # any more general directories which might exist as well.
531     #
532     # User patches are intended for quick testing of patches without ebuild
533     # modifications, as well as for permanent customizations a user might
534     # desire. Obviously, there can be no official support for arbitrarily
535     # patched ebuilds. So whenever a build log in a bug report mentions that
536     # user patches were applied, the user should be asked to reproduce the
537     # problem without these.
538     #
539     # Not all ebuilds do call this function, so placing patches in the
540     # stated directory might or might not work, depending on the package and
541     # the eclasses it inherits and uses. It is safe to call the function
542     # repeatedly, so it is always possible to add a call at the ebuild
543     # level. The first call is the time when the patches will be
544     # applied.
545     #
546     # Ideally, this function should be called after gentoo-specific patches
547     # have been applied, so that their code can be modified as well, but
548     # before calls to e.g. eautoreconf, as the user patches might affect
549     # autotool input files as well.
550 vapier 1.318 epatch_user() {
551     [[ $# -ne 0 ]] && die "epatch_user takes no options"
552    
553 vapier 1.361 # Allow multiple calls to this function; ignore all but the first
554 vapier 1.383 local applied="${T}/epatch_user.log"
555 vapier 1.361 [[ -e ${applied} ]] && return 2
556    
557 vapier 1.318 # don't clobber any EPATCH vars that the parent might want
558 zmedico 1.323 local EPATCH_SOURCE check base=${PORTAGE_CONFIGROOT%/}/etc/portage/patches
559 ulm 1.378 for check in ${CATEGORY}/{${P}-${PR},${P},${PN}}; do
560 vapier 1.318 EPATCH_SOURCE=${base}/${CTARGET}/${check}
561     [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${CHOST}/${check}
562     [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${check}
563     if [[ -d ${EPATCH_SOURCE} ]] ; then
564     EPATCH_SOURCE=${EPATCH_SOURCE} \
565     EPATCH_SUFFIX="patch" \
566     EPATCH_FORCE="yes" \
567     EPATCH_MULTI_MSG="Applying user patches from ${EPATCH_SOURCE} ..." \
568     epatch
569 vapier 1.361 echo "${EPATCH_SOURCE}" > "${applied}"
570 vapier 1.349 return 0
571 vapier 1.318 fi
572     done
573 vapier 1.361 echo "none" > "${applied}"
574 vapier 1.349 return 1
575 vapier 1.318 }
576 azarah 1.26
577 vapier 1.283 # @FUNCTION: emktemp
578     # @USAGE: [temp dir]
579     # @DESCRIPTION:
580 vapier 1.52 # Cheap replacement for when debianutils (and thus mktemp)
581 vapier 1.283 # does not exist on the users system.
582 vapier 1.117 emktemp() {
583 vapier 1.119 local exe="touch"
584 vapier 1.194 [[ $1 == -d ]] && exe="mkdir" && shift
585     local topdir=$1
586 mr_bones_ 1.100
587 vapier 1.194 if [[ -z ${topdir} ]] ; then
588     [[ -z ${T} ]] \
589 vapier 1.117 && topdir="/tmp" \
590 vapier 1.194 || topdir=${T}
591 vapier 1.117 fi
592    
593 vapier 1.280 if ! type -P mktemp > /dev/null ; then
594     # system lacks `mktemp` so we have to fake it
595 vapier 1.117 local tmp=/
596 vapier 1.194 while [[ -e ${tmp} ]] ; do
597     tmp=${topdir}/tmp.${RANDOM}.${RANDOM}.${RANDOM}
598 vapier 1.117 done
599 vapier 1.194 ${exe} "${tmp}" || ${exe} -p "${tmp}"
600 vapier 1.117 echo "${tmp}"
601 vapier 1.52 else
602 vapier 1.280 # the args here will give slightly wierd names on BSD,
603     # but should produce a usable file on all userlands
604 flameeyes 1.223 if [[ ${exe} == "touch" ]] ; then
605 vapier 1.280 TMPDIR="${topdir}" mktemp -t tmp.XXXXXXXXXX
606 flameeyes 1.223 else
607 vapier 1.280 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX
608 flameeyes 1.223 fi
609 vapier 1.52 fi
610     }
611    
612 vapier 1.283 # @FUNCTION: edos2unix
613     # @USAGE: <file> [more files ...]
614     # @DESCRIPTION:
615     # A handy replacement for dos2unix, recode, fixdos, etc... This allows you
616     # to remove all of these text utilities from DEPEND variables because this
617     # is a script based solution. Just give it a list of files to convert and
618     # they will all be changed from the DOS CRLF format to the UNIX LF format.
619 vapier 1.24 edos2unix() {
620 vapier 1.366 [[ $# -eq 0 ]] && return 0
621     sed -i 's/\r$//' -- "$@" || die
622 vapier 1.39 }
623    
624 jlec 1.377 # @FUNCTION: make_desktop_entry
625     # @USAGE: make_desktop_entry(<command>, [name], [icon], [type], [fields])
626     # @DESCRIPTION:
627     # Make a .desktop file.
628     #
629     # @CODE
630     # binary: what command does the app run with ?
631     # name: the name that will show up in the menu
632     # icon: give your little like a pretty little icon ...
633     # this can be relative (to /usr/share/pixmaps) or
634     # a full path to an icon
635     # type: what kind of application is this?
636     # for categories:
637     # http://standards.freedesktop.org/menu-spec/latest/apa.html
638     # if unset, function tries to guess from package's category
639 vapier 1.341 # fields: extra fields to append to the desktop file; a printf string
640 jlec 1.377 # @CODE
641 vapier 1.39 make_desktop_entry() {
642 vapier 1.341 [[ -z $1 ]] && die "make_desktop_entry: You must specify the executable"
643 vapier 1.39
644 vapier 1.158 local exec=${1}
645     local name=${2:-${PN}}
646 wolf31o2 1.293 local icon=${3:-${PN}}
647 vapier 1.158 local type=${4}
648 vapier 1.341 local fields=${5}
649 vapier 1.158
650     if [[ -z ${type} ]] ; then
651     local catmaj=${CATEGORY%%-*}
652     local catmin=${CATEGORY##*-}
653     case ${catmaj} in
654     app)
655     case ${catmin} in
656 pacho 1.384 accessibility) type="Utility;Accessibility";;
657 vapier 1.338 admin) type=System;;
658     antivirus) type=System;;
659 pacho 1.384 arch) type="Utility;Archiving";;
660     backup) type="Utility;Archiving";;
661     cdr) type="AudioVideo;DiscBurning";;
662     dicts) type="Office;Dictionary";;
663 vapier 1.338 doc) type=Documentation;;
664 pacho 1.384 editors) type="Utility;TextEditor";;
665     emacs) type="Development;TextEditor";;
666     emulation) type="System;Emulator";;
667     laptop) type="Settings;HardwareSettings";;
668 vapier 1.338 office) type=Office;;
669 pacho 1.384 pda) type="Office;PDA";;
670     vim) type="Development;TextEditor";;
671     xemacs) type="Development;TextEditor";;
672 vapier 1.158 esac
673 azarah 1.59 ;;
674 vapier 1.158
675     dev)
676 vapier 1.159 type="Development"
677 vapier 1.158 ;;
678    
679     games)
680     case ${catmin} in
681 wolf31o2 1.265 action|fps) type=ActionGame;;
682 vapier 1.338 arcade) type=ArcadeGame;;
683     board) type=BoardGame;;
684     emulation) type=Emulator;;
685     kids) type=KidsGame;;
686     puzzle) type=LogicGame;;
687     roguelike) type=RolePlaying;;
688     rpg) type=RolePlaying;;
689 vapier 1.158 simulation) type=Simulation;;
690 vapier 1.338 sports) type=SportsGame;;
691     strategy) type=StrategyGame;;
692 vapier 1.158 esac
693 vapier 1.159 type="Game;${type}"
694 vapier 1.158 ;;
695    
696 vapier 1.284 gnome)
697     type="Gnome;GTK"
698     ;;
699    
700     kde)
701     type="KDE;Qt"
702     ;;
703    
704 vapier 1.158 mail)
705 vapier 1.159 type="Network;Email"
706 vapier 1.158 ;;
707    
708     media)
709     case ${catmin} in
710 vapier 1.339 gfx)
711     type=Graphics
712     ;;
713     *)
714     case ${catmin} in
715     radio) type=Tuner;;
716     sound) type=Audio;;
717     tv) type=TV;;
718     video) type=Video;;
719     esac
720     type="AudioVideo;${type}"
721     ;;
722 vapier 1.158 esac
723 wolf31o2 1.65 ;;
724 vapier 1.158
725     net)
726     case ${catmin} in
727     dialup) type=Dialup;;
728 vapier 1.338 ftp) type=FileTransfer;;
729     im) type=InstantMessaging;;
730     irc) type=IRCClient;;
731     mail) type=Email;;
732     news) type=News;;
733     nntp) type=News;;
734     p2p) type=FileTransfer;;
735     voip) type=Telephony;;
736 vapier 1.158 esac
737 vapier 1.159 type="Network;${type}"
738 vapier 1.158 ;;
739    
740     sci)
741     case ${catmin} in
742 vapier 1.284 astro*) type=Astronomy;;
743 vapier 1.338 bio*) type=Biology;;
744     calc*) type=Calculator;;
745     chem*) type=Chemistry;;
746 vapier 1.284 elec*) type=Electronics;;
747 vapier 1.338 geo*) type=Geology;;
748     math*) type=Math;;
749 vapier 1.284 physics) type=Physics;;
750     visual*) type=DataVisualization;;
751 vapier 1.159 esac
752 abcd 1.336 type="Education;Science;${type}"
753 vapier 1.158 ;;
754    
755 vapier 1.284 sys)
756     type="System"
757     ;;
758    
759 vapier 1.158 www)
760     case ${catmin} in
761     client) type=WebBrowser;;
762     esac
763 abcd 1.336 type="Network;${type}"
764 azarah 1.59 ;;
765 vapier 1.158
766 azarah 1.59 *)
767     type=
768     ;;
769 vapier 1.39 esac
770     fi
771 carlo 1.177 if [ "${SLOT}" == "0" ] ; then
772     local desktop_name="${PN}"
773     else
774     local desktop_name="${PN}-${SLOT}"
775     fi
776 vapier 1.272 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop"
777 vapier 1.271 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop
778 vapier 1.39
779 abcd 1.336 # Don't append another ";" when a valid category value is provided.
780     type=${type%;}${type:+;}
781    
782     eshopts_push -s extglob
783     if [[ -n ${icon} && ${icon} != /* ]] && [[ ${icon} == *.xpm || ${icon} == *.png || ${icon} == *.svg ]]; then
784     ewarn "As described in the Icon Theme Specification, icon file extensions are not"
785     ewarn "allowed in .desktop files if the value is not an absolute path."
786     icon=${icon%.@(xpm|png|svg)}
787     fi
788     eshopts_pop
789    
790 vapier 1.271 cat <<-EOF > "${desktop}"
791     [Desktop Entry]
792     Name=${name}
793     Type=Application
794     Comment=${DESCRIPTION}
795     Exec=${exec}
796     TryExec=${exec%% *}
797     Icon=${icon}
798 abcd 1.336 Categories=${type}
799 vapier 1.271 EOF
800 vapier 1.39
801 vapier 1.341 if [[ ${fields:-=} != *=* ]] ; then
802     # 5th arg used to be value to Path=
803     ewarn "make_desktop_entry: update your 5th arg to read Path=${fields}"
804     fields="Path=${fields}"
805     fi
806 vapier 1.342 [[ -n ${fields} ]] && printf '%b\n' "${fields}" >> "${desktop}"
807 wolf31o2 1.293
808 vapier 1.204 (
809     # wrap the env here so that the 'insinto' call
810     # doesn't corrupt the env of the caller
811     insinto /usr/share/applications
812     doins "${desktop}"
813 vapier 1.340 ) || die "installing desktop file failed"
814 danarmak 1.32 }
815    
816 vapier 1.283 # @FUNCTION: validate_desktop_entries
817     # @USAGE: [directories]
818     # @MAINTAINER:
819     # Carsten Lohrke <carlo@gentoo.org>
820     # @DESCRIPTION:
821 carlo 1.278 # Validate desktop entries using desktop-file-utils
822 carlo 1.277 validate_desktop_entries() {
823     if [[ -x /usr/bin/desktop-file-validate ]] ; then
824     einfo "Checking desktop entry validity"
825     local directories=""
826 carlo 1.279 for d in /usr/share/applications $@ ; do
827     [[ -d ${D}${d} ]] && directories="${directories} ${D}${d}"
828 carlo 1.277 done
829 carlo 1.279 if [[ -n ${directories} ]] ; then
830     for FILE in $(find ${directories} -name "*\.desktop" \
831     -not -path '*.hidden*' | sort -u 2>/dev/null)
832     do
833     local temp=$(desktop-file-validate ${FILE} | grep -v "warning:" | \
834     sed -e "s|error: ||" -e "s|${FILE}:|--|g" )
835     [[ -n $temp ]] && elog ${temp/--/${FILE/${D}/}:}
836     done
837     fi
838 carlo 1.277 echo ""
839     else
840     einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo."
841     fi
842     }
843    
844 vapier 1.283 # @FUNCTION: make_session_desktop
845 vapier 1.314 # @USAGE: <title> <command> [command args...]
846 vapier 1.283 # @DESCRIPTION:
847     # Make a GDM/KDM Session file. The title is the file to execute to start the
848     # Window Manager. The command is the name of the Window Manager.
849 vapier 1.314 #
850     # You can set the name of the file via the ${wm} variable.
851 lanius 1.133 make_session_desktop() {
852 vapier 1.314 [[ -z $1 ]] && eerror "$0: You must specify the title" && return 1
853     [[ -z $2 ]] && eerror "$0: You must specify the command" && return 1
854 lanius 1.133
855 vapier 1.167 local title=$1
856     local command=$2
857 vapier 1.314 local desktop=${T}/${wm:-${PN}}.desktop
858     shift 2
859 lanius 1.133
860 vapier 1.271 cat <<-EOF > "${desktop}"
861     [Desktop Entry]
862     Name=${title}
863     Comment=This session logs you into ${title}
864 vapier 1.314 Exec=${command} $*
865 vapier 1.271 TryExec=${command}
866 vapier 1.314 Type=XSession
867 vapier 1.271 EOF
868 lanius 1.133
869 vapier 1.271 (
870     # wrap the env here so that the 'insinto' call
871     # doesn't corrupt the env of the caller
872 lanius 1.133 insinto /usr/share/xsessions
873     doins "${desktop}"
874 vapier 1.271 )
875 lanius 1.133 }
876    
877 vapier 1.283 # @FUNCTION: domenu
878     # @USAGE: <menus>
879     # @DESCRIPTION:
880     # Install the list of .desktop menu files into the appropriate directory
881     # (/usr/share/applications).
882 lanius 1.133 domenu() {
883 vapier 1.271 (
884     # wrap the env here so that the 'insinto' call
885     # doesn't corrupt the env of the caller
886     local i j ret=0
887 lanius 1.133 insinto /usr/share/applications
888 vapier 1.167 for i in "$@" ; do
889     if [[ -f ${i} ]] ; then
890     doins "${i}"
891 vapier 1.271 ((ret+=$?))
892 vapier 1.167 elif [[ -d ${i} ]] ; then
893     for j in "${i}"/*.desktop ; do
894     doins "${j}"
895 vapier 1.271 ((ret+=$?))
896 lanius 1.133 done
897 vapier 1.285 else
898     ((++ret))
899 swegener 1.190 fi
900 lanius 1.133 done
901 vapier 1.271 exit ${ret}
902     )
903 lanius 1.133 }
904 vapier 1.283
905     # @FUNCTION: newmenu
906     # @USAGE: <menu> <newname>
907     # @DESCRIPTION:
908     # Like all other new* functions, install the specified menu as newname.
909 vapier 1.167 newmenu() {
910 vapier 1.271 (
911     # wrap the env here so that the 'insinto' call
912     # doesn't corrupt the env of the caller
913 vapier 1.167 insinto /usr/share/applications
914 vapier 1.271 newins "$@"
915     )
916 vapier 1.167 }
917 lanius 1.133
918 vapier 1.283 # @FUNCTION: doicon
919     # @USAGE: <list of icons>
920     # @DESCRIPTION:
921     # Install the list of icons into the icon directory (/usr/share/pixmaps).
922     # This is useful in conjunction with creating desktop/menu files.
923 lanius 1.133 doicon() {
924 vapier 1.271 (
925     # wrap the env here so that the 'insinto' call
926     # doesn't corrupt the env of the caller
927     local i j ret
928 lanius 1.133 insinto /usr/share/pixmaps
929 vapier 1.167 for i in "$@" ; do
930     if [[ -f ${i} ]] ; then
931     doins "${i}"
932 vapier 1.271 ((ret+=$?))
933 vapier 1.167 elif [[ -d ${i} ]] ; then
934     for j in "${i}"/*.png ; do
935     doins "${j}"
936 vapier 1.271 ((ret+=$?))
937 lanius 1.133 done
938 vapier 1.285 else
939     ((++ret))
940 swegener 1.190 fi
941 lanius 1.133 done
942 vapier 1.271 exit ${ret}
943     )
944 lanius 1.133 }
945 vapier 1.283
946     # @FUNCTION: newicon
947     # @USAGE: <icon> <newname>
948     # @DESCRIPTION:
949     # Like all other new* functions, install the specified icon as newname.
950 vapier 1.167 newicon() {
951 vapier 1.271 (
952     # wrap the env here so that the 'insinto' call
953     # doesn't corrupt the env of the caller
954 vapier 1.167 insinto /usr/share/pixmaps
955 vapier 1.271 newins "$@"
956     )
957 vapier 1.167 }
958 lanius 1.133
959 ulm 1.380 # @FUNCTION: cdrom_get_cds
960     # @USAGE: <file on cd1> [file on cd2] [file on cd3] [...]
961     # @DESCRIPTION:
962     # Aquire cd(s) for those lovely cd-based emerges. Yes, this violates
963     # the whole 'non-interactive' policy, but damnit I want CD support !
964     #
965     # With these cdrom functions we handle all the user interaction and
966     # standardize everything. All you have to do is call cdrom_get_cds()
967     # and when the function returns, you can assume that the cd has been
968     # found at CDROM_ROOT.
969     #
970     # The function will attempt to locate a cd based upon a file that is on
971     # the cd. The more files you give this function, the more cds
972     # the cdrom functions will handle.
973     #
974     # Normally the cdrom functions will refer to the cds as 'cd #1', 'cd #2',
975     # etc... If you want to give the cds better names, then just export
976     # the appropriate CDROM_NAME variable before calling cdrom_get_cds().
977     # Use CDROM_NAME for one cd, or CDROM_NAME_# for multiple cds. You can
978     # also use the CDROM_NAME_SET bash array.
979     #
980     # For those multi cd ebuilds, see the cdrom_load_next_cd() function.
981     cdrom_get_cds() {
982     # first we figure out how many cds we're dealing with by
983     # the # of files they gave us
984     local cdcnt=0
985     local f=
986     for f in "$@" ; do
987     ((++cdcnt))
988     export CDROM_CHECK_${cdcnt}="$f"
989     done
990     export CDROM_TOTAL_CDS=${cdcnt}
991     export CDROM_CURRENT_CD=1
992    
993     # now we see if the user gave use CD_ROOT ...
994     # if they did, let's just believe them that it's correct
995     if [[ -n ${CD_ROOT}${CD_ROOT_1} ]] ; then
996     local var=
997     cdcnt=0
998     while [[ ${cdcnt} -lt ${CDROM_TOTAL_CDS} ]] ; do
999     ((++cdcnt))
1000     var="CD_ROOT_${cdcnt}"
1001     [[ -z ${!var} ]] && var="CD_ROOT"
1002     if [[ -z ${!var} ]] ; then
1003     eerror "You must either use just the CD_ROOT"
1004     eerror "or specify ALL the CD_ROOT_X variables."
1005     eerror "In this case, you will need ${CDROM_TOTAL_CDS} CD_ROOT_X variables."
1006     die "could not locate CD_ROOT_${cdcnt}"
1007     fi
1008     done
1009     export CDROM_ROOT=${CD_ROOT_1:-${CD_ROOT}}
1010     einfo "Found CD #${CDROM_CURRENT_CD} root at ${CDROM_ROOT}"
1011     export CDROM_SET=-1
1012     for f in ${CDROM_CHECK_1//:/ } ; do
1013     ((++CDROM_SET))
1014     [[ -e ${CDROM_ROOT}/${f} ]] && break
1015     done
1016     export CDROM_MATCH=${f}
1017     return
1018     fi
1019    
1020     # User didn't help us out so lets make sure they know they can
1021     # simplify the whole process ...
1022     if [[ ${CDROM_TOTAL_CDS} -eq 1 ]] ; then
1023     einfo "This ebuild will need the ${CDROM_NAME:-cdrom for ${PN}}"
1024     echo
1025     einfo "If you do not have the CD, but have the data files"
1026     einfo "mounted somewhere on your filesystem, just export"
1027     einfo "the variable CD_ROOT so that it points to the"
1028     einfo "directory containing the files."
1029     echo
1030     einfo "For example:"
1031     einfo "export CD_ROOT=/mnt/cdrom"
1032     echo
1033     else
1034     if [[ -n ${CDROM_NAME_SET} ]] ; then
1035     # Translate the CDROM_NAME_SET array into CDROM_NAME_#
1036     cdcnt=0
1037     while [[ ${cdcnt} -lt ${CDROM_TOTAL_CDS} ]] ; do
1038     ((++cdcnt))
1039     export CDROM_NAME_${cdcnt}="${CDROM_NAME_SET[$((${cdcnt}-1))]}"
1040     done
1041     fi
1042    
1043     einfo "This package will need access to ${CDROM_TOTAL_CDS} cds."
1044     cdcnt=0
1045     while [[ ${cdcnt} -lt ${CDROM_TOTAL_CDS} ]] ; do
1046     ((++cdcnt))
1047     var="CDROM_NAME_${cdcnt}"
1048     [[ ! -z ${!var} ]] && einfo " CD ${cdcnt}: ${!var}"
1049     done
1050     echo
1051     einfo "If you do not have the CDs, but have the data files"
1052     einfo "mounted somewhere on your filesystem, just export"
1053     einfo "the following variables so they point to the right place:"
1054     einfon ""
1055     cdcnt=0
1056     while [[ ${cdcnt} -lt ${CDROM_TOTAL_CDS} ]] ; do
1057     ((++cdcnt))
1058     echo -n " CD_ROOT_${cdcnt}"
1059     done
1060     echo
1061     einfo "Or, if you have all the files in the same place, or"
1062     einfo "you only have one cdrom, you can export CD_ROOT"
1063     einfo "and that place will be used as the same data source"
1064     einfo "for all the CDs."
1065     echo
1066     einfo "For example:"
1067     einfo "export CD_ROOT_1=/mnt/cdrom"
1068     echo
1069     fi
1070    
1071     export CDROM_SET=""
1072     export CDROM_CURRENT_CD=0
1073     cdrom_load_next_cd
1074     }
1075    
1076     # @FUNCTION: cdrom_load_next_cd
1077     # @DESCRIPTION:
1078     # Some packages are so big they come on multiple CDs. When you're done reading
1079     # files off a CD and want access to the next one, just call this function.
1080     # Again, all the messy details of user interaction are taken care of for you.
1081     # Once this returns, just read the variable CDROM_ROOT for the location of the
1082     # mounted CD. Note that you can only go forward in the CD list, so make sure
1083     # you only call this function when you're done using the current CD.
1084     cdrom_load_next_cd() {
1085     local var
1086     ((++CDROM_CURRENT_CD))
1087    
1088     unset CDROM_ROOT
1089     var=CD_ROOT_${CDROM_CURRENT_CD}
1090     [[ -z ${!var} ]] && var="CD_ROOT"
1091     if [[ -z ${!var} ]] ; then
1092     var="CDROM_CHECK_${CDROM_CURRENT_CD}"
1093     _cdrom_locate_file_on_cd ${!var}
1094     else
1095     export CDROM_ROOT=${!var}
1096     fi
1097    
1098     einfo "Found CD #${CDROM_CURRENT_CD} root at ${CDROM_ROOT}"
1099     }
1100    
1101     # this is used internally by the cdrom_get_cds() and cdrom_load_next_cd()
1102     # functions. this should *never* be called from an ebuild.
1103     # all it does is try to locate a give file on a cd ... if the cd isn't
1104     # found, then a message asking for the user to insert the cdrom will be
1105     # displayed and we'll hang out here until:
1106     # (1) the file is found on a mounted cdrom
1107     # (2) the user hits CTRL+C
1108     _cdrom_locate_file_on_cd() {
1109     local mline=""
1110     local showedmsg=0 showjolietmsg=0
1111    
1112     while [[ -z ${CDROM_ROOT} ]] ; do
1113     local i=0
1114     local -a cdset=(${*//:/ })
1115     if [[ -n ${CDROM_SET} ]] ; then
1116     cdset=(${cdset[${CDROM_SET}]})
1117     fi
1118    
1119     while [[ -n ${cdset[${i}]} ]] ; do
1120     local dir=$(dirname ${cdset[${i}]})
1121     local file=$(basename ${cdset[${i}]})
1122    
1123     local point= node= fs= foo=
1124     while read point node fs foo ; do
1125     [[ " cd9660 iso9660 udf " != *" ${fs} "* ]] && \
1126     ! [[ ${fs} == "subfs" && ",${opts}," == *",fs=cdfss,"* ]] \
1127     && continue
1128     point=${point//\040/ }
1129     [[ ! -d ${point}/${dir} ]] && continue
1130     [[ -z $(find "${point}/${dir}" -maxdepth 1 -iname "${file}") ]] && continue
1131     export CDROM_ROOT=${point}
1132     export CDROM_SET=${i}
1133     export CDROM_MATCH=${cdset[${i}]}
1134     return
1135     done <<< "$(get_mounts)"
1136    
1137     ((++i))
1138     done
1139    
1140     echo
1141     if [[ ${showedmsg} -eq 0 ]] ; then
1142     if [[ ${CDROM_TOTAL_CDS} -eq 1 ]] ; then
1143     if [[ -z ${CDROM_NAME} ]] ; then
1144     einfo "Please insert+mount the cdrom for ${PN} now !"
1145     else
1146     einfo "Please insert+mount the ${CDROM_NAME} cdrom now !"
1147     fi
1148     else
1149     if [[ -z ${CDROM_NAME_1} ]] ; then
1150     einfo "Please insert+mount cd #${CDROM_CURRENT_CD} for ${PN} now !"
1151     else
1152     local var="CDROM_NAME_${CDROM_CURRENT_CD}"
1153     einfo "Please insert+mount the ${!var} cdrom now !"
1154     fi
1155     fi
1156     showedmsg=1
1157     fi
1158     einfo "Press return to scan for the cd again"
1159     einfo "or hit CTRL+C to abort the emerge."
1160     echo
1161     if [[ ${showjolietmsg} -eq 0 ]] ; then
1162     showjolietmsg=1
1163     else
1164     ewarn "If you are having trouble with the detection"
1165     ewarn "of your CD, it is possible that you do not have"
1166     ewarn "Joliet support enabled in your kernel. Please"
1167     ewarn "check that CONFIG_JOLIET is enabled in your kernel."
1168     ebeep 5
1169     fi
1170     read || die "something is screwed with your system"
1171     done
1172     }
1173    
1174 vapier 1.287 # @FUNCTION: strip-linguas
1175     # @USAGE: [<allow LINGUAS>|<-i|-u> <directories of .po files>]
1176     # @DESCRIPTION:
1177 mr_bones_ 1.100 # Make sure that LINGUAS only contains languages that
1178 vapier 1.287 # a package can support. The first form allows you to
1179     # specify a list of LINGUAS. The -i builds a list of po
1180     # files found in all the directories and uses the
1181     # intersection of the lists. The -u builds a list of po
1182     # files found in all the directories and uses the union
1183     # of the lists.
1184 vapier 1.92 strip-linguas() {
1185 vapier 1.242 local ls newls nols
1186 vapier 1.154 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then
1187     local op=$1; shift
1188 vapier 1.315 ls=$(find "$1" -name '*.po' -exec basename {} .po ';'); shift
1189 vapier 1.92 local d f
1190     for d in "$@" ; do
1191 vapier 1.154 if [[ ${op} == "-u" ]] ; then
1192     newls=${ls}
1193 vapier 1.92 else
1194     newls=""
1195     fi
1196 vapier 1.315 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do
1197 vapier 1.154 if [[ ${op} == "-i" ]] ; then
1198 ssuominen 1.358 has ${f} ${ls} && newls="${newls} ${f}"
1199 vapier 1.92 else
1200 ssuominen 1.358 has ${f} ${ls} || newls="${newls} ${f}"
1201 vapier 1.92 fi
1202     done
1203 vapier 1.154 ls=${newls}
1204 vapier 1.92 done
1205     else
1206 vapier 1.236 ls="$@"
1207 vapier 1.92 fi
1208    
1209 vapier 1.242 nols=""
1210 vapier 1.92 newls=""
1211     for f in ${LINGUAS} ; do
1212 ssuominen 1.358 if has ${f} ${ls} ; then
1213 vapier 1.120 newls="${newls} ${f}"
1214 vapier 1.92 else
1215 vapier 1.242 nols="${nols} ${f}"
1216 vapier 1.92 fi
1217     done
1218 vapier 1.244 [[ -n ${nols} ]] \
1219 vapier 1.316 && ewarn "Sorry, but ${PN} does not support the LINGUAS:" ${nols}
1220 vapier 1.237 export LINGUAS=${newls:1}
1221 vapier 1.92 }
1222 iggy 1.110
1223 vapier 1.283 # @FUNCTION: preserve_old_lib
1224     # @USAGE: <libs to preserve> [more libs]
1225     # @DESCRIPTION:
1226     # These functions are useful when a lib in your package changes ABI SONAME.
1227     # An example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0
1228 eradicator 1.111 # would break packages that link against it. Most people get around this
1229     # by using the portage SLOT mechanism, but that is not always a relevant
1230 vapier 1.283 # solution, so instead you can call this from pkg_preinst. See also the
1231     # preserve_old_lib_notify function.
1232 eradicator 1.111 preserve_old_lib() {
1233 vapier 1.268 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then
1234 vapier 1.267 eerror "preserve_old_lib() must be called from pkg_preinst() only"
1235 vapier 1.276 die "Invalid preserve_old_lib() usage"
1236 vapier 1.267 fi
1237     [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]"
1238    
1239 vapier 1.297 # let portage worry about it
1240     has preserve-libs ${FEATURES} && return 0
1241    
1242 vapier 1.267 local lib dir
1243     for lib in "$@" ; do
1244     [[ -e ${ROOT}/${lib} ]] || continue
1245     dir=${lib%/*}
1246     dodir ${dir} || die "dodir ${dir} failed"
1247     cp "${ROOT}"/${lib} "${D}"/${lib} || die "cp ${lib} failed"
1248     touch "${D}"/${lib}
1249     done
1250 eradicator 1.111 }
1251    
1252 vapier 1.283 # @FUNCTION: preserve_old_lib_notify
1253     # @USAGE: <libs to notify> [more libs]
1254     # @DESCRIPTION:
1255     # Spit helpful messages about the libraries preserved by preserve_old_lib.
1256 eradicator 1.111 preserve_old_lib_notify() {
1257 vapier 1.268 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then
1258 vapier 1.267 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only"
1259 vapier 1.276 die "Invalid preserve_old_lib_notify() usage"
1260 vapier 1.267 fi
1261    
1262 vapier 1.297 # let portage worry about it
1263     has preserve-libs ${FEATURES} && return 0
1264    
1265 vapier 1.267 local lib notice=0
1266     for lib in "$@" ; do
1267     [[ -e ${ROOT}/${lib} ]] || continue
1268     if [[ ${notice} -eq 0 ]] ; then
1269     notice=1
1270     ewarn "Old versions of installed libraries were detected on your system."
1271     ewarn "In order to avoid breaking packages that depend on these old libs,"
1272     ewarn "the libraries are not being removed. You need to run revdep-rebuild"
1273     ewarn "in order to remove these old dependencies. If you do not have this"
1274     ewarn "helper program, simply emerge the 'gentoolkit' package."
1275     ewarn
1276     fi
1277 vapier 1.355 # temp hack for #348634 #357225
1278     [[ ${PN} == "mpfr" ]] && lib=${lib##*/}
1279 vapier 1.352 ewarn " # revdep-rebuild --library '${lib}'"
1280 vapier 1.267 done
1281 vapier 1.291 if [[ ${notice} -eq 1 ]] ; then
1282     ewarn
1283     ewarn "Once you've finished running revdep-rebuild, it should be safe to"
1284 vapier 1.300 ewarn "delete the old libraries. Here is a copy & paste for the lazy:"
1285     for lib in "$@" ; do
1286     ewarn " # rm '${lib}'"
1287     done
1288 vapier 1.291 fi
1289 eradicator 1.111 }
1290 vapier 1.125
1291 vapier 1.283 # @FUNCTION: built_with_use
1292     # @USAGE: [--hidden] [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags>
1293     # @DESCRIPTION:
1294 betelgeuse 1.329 #
1295     # Deprecated: Use EAPI 2 use deps in DEPEND|RDEPEND and with has_version calls.
1296     #
1297 vapier 1.283 # A temporary hack until portage properly supports DEPENDing on USE
1298     # flags being enabled in packages. This will check to see if the specified
1299     # DEPEND atom was built with the specified list of USE flags. The
1300     # --missing option controls the behavior if called on a package that does
1301     # not actually support the defined USE flags (aka listed in IUSE).
1302     # The default is to abort (call die). The -a and -o flags control
1303     # the requirements of the USE flags. They correspond to "and" and "or"
1304     # logic. So the -a flag means all listed USE flags must be enabled
1305 opfer 1.302 # while the -o flag means at least one of the listed IUSE flags must be
1306 vapier 1.283 # enabled. The --hidden option is really for internal use only as it
1307     # means the USE flag we're checking is hidden expanded, so it won't be found
1308     # in IUSE like normal USE flags.
1309 swegener 1.286 #
1310 vapier 1.283 # Remember that this function isn't terribly intelligent so order of optional
1311     # flags matter.
1312 vapier 1.125 built_with_use() {
1313 vapier 1.275 local hidden="no"
1314     if [[ $1 == "--hidden" ]] ; then
1315     hidden="yes"
1316     shift
1317     fi
1318    
1319 vapier 1.269 local missing_action="die"
1320     if [[ $1 == "--missing" ]] ; then
1321     missing_action=$2
1322     shift ; shift
1323     case ${missing_action} in
1324     true|false|die) ;;
1325     *) die "unknown action '${missing_action}'";;
1326     esac
1327     fi
1328    
1329 vapier 1.130 local opt=$1
1330     [[ ${opt:0:1} = "-" ]] && shift || opt="-a"
1331    
1332     local PKG=$(best_version $1)
1333 vapier 1.247 [[ -z ${PKG} ]] && die "Unable to resolve $1 to an installed package"
1334 vapier 1.130 shift
1335    
1336 vapier 1.213 local USEFILE=${ROOT}/var/db/pkg/${PKG}/USE
1337 vapier 1.249 local IUSEFILE=${ROOT}/var/db/pkg/${PKG}/IUSE
1338 vapier 1.213
1339 cardoe 1.273 # if the IUSE file doesn't exist, the read will error out, we need to handle
1340     # this gracefully
1341 vapier 1.275 if [[ ! -e ${USEFILE} ]] || [[ ! -e ${IUSEFILE} && ${hidden} == "no" ]] ; then
1342 cardoe 1.273 case ${missing_action} in
1343     true) return 0;;
1344     false) return 1;;
1345     die) die "Unable to determine what USE flags $PKG was built with";;
1346     esac
1347     fi
1348    
1349 vapier 1.275 if [[ ${hidden} == "no" ]] ; then
1350 zmedico 1.301 local IUSE_BUILT=( $(<"${IUSEFILE}") )
1351 vapier 1.275 # Don't check USE_EXPAND #147237
1352     local expand
1353     for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do
1354     if [[ $1 == ${expand}_* ]] ; then
1355     expand=""
1356     break
1357     fi
1358     done
1359     if [[ -n ${expand} ]] ; then
1360 zmedico 1.301 if ! has $1 ${IUSE_BUILT[@]#[-+]} ; then
1361 vapier 1.275 case ${missing_action} in
1362     true) return 0;;
1363     false) return 1;;
1364     die) die "$PKG does not actually support the $1 USE flag!";;
1365     esac
1366     fi
1367 vapier 1.269 fi
1368 vapier 1.250 fi
1369 vapier 1.249
1370 vapier 1.125 local USE_BUILT=$(<${USEFILE})
1371 vapier 1.130 while [[ $# -gt 0 ]] ; do
1372     if [[ ${opt} = "-o" ]] ; then
1373     has $1 ${USE_BUILT} && return 0
1374     else
1375     has $1 ${USE_BUILT} || return 1
1376     fi
1377 vapier 1.125 shift
1378     done
1379 vapier 1.130 [[ ${opt} = "-a" ]]
1380 vapier 1.125 }
1381 vapier 1.126
1382 vapier 1.289 # @FUNCTION: epunt_cxx
1383 vapier 1.283 # @USAGE: [dir to scan]
1384     # @DESCRIPTION:
1385     # Many configure scripts wrongly bail when a C++ compiler could not be
1386     # detected. If dir is not specified, then it defaults to ${S}.
1387     #
1388     # http://bugs.gentoo.org/73450
1389 vapier 1.126 epunt_cxx() {
1390 vapier 1.127 local dir=$1
1391     [[ -z ${dir} ]] && dir=${S}
1392     ebegin "Removing useless C++ checks"
1393     local f
1394 vapier 1.294 find "${dir}" -name configure | while read f ; do
1395     patch --no-backup-if-mismatch -p0 "${f}" "${PORTDIR}/eclass/ELT-patches/nocxx/nocxx.patch" > /dev/null
1396 vapier 1.127 done
1397     eend 0
1398 vapier 1.126 }
1399 ka0ttic 1.143
1400 vapier 1.283 # @FUNCTION: make_wrapper
1401 wolf31o2 1.295 # @USAGE: <wrapper> <target> [chdir] [libpaths] [installpath]
1402 vapier 1.283 # @DESCRIPTION:
1403     # Create a shell wrapper script named wrapper in installpath
1404     # (defaults to the bindir) to execute target (default of wrapper) by
1405     # first optionally setting LD_LIBRARY_PATH to the colon-delimited
1406     # libpaths followed by optionally changing directory to chdir.
1407 wolf31o2 1.160 make_wrapper() {
1408 wolf31o2 1.164 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5
1409 wolf31o2 1.160 local tmpwrapper=$(emktemp)
1410 vapier 1.202 # We don't want to quote ${bin} so that people can pass complex
1411     # things as $bin ... "./someprog --args"
1412 wolf31o2 1.160 cat << EOF > "${tmpwrapper}"
1413     #!/bin/sh
1414 vapier 1.201 cd "${chdir:-.}"
1415 vapier 1.210 if [ -n "${libdir}" ] ; then
1416     if [ "\${LD_LIBRARY_PATH+set}" = "set" ] ; then
1417     export LD_LIBRARY_PATH="\${LD_LIBRARY_PATH}:${libdir}"
1418     else
1419     export LD_LIBRARY_PATH="${libdir}"
1420     fi
1421 vapier 1.201 fi
1422 vapier 1.202 exec ${bin} "\$@"
1423 wolf31o2 1.160 EOF
1424     chmod go+rx "${tmpwrapper}"
1425 vapier 1.201 if [[ -n ${path} ]] ; then
1426 vapier 1.283 (
1427 vapier 1.201 exeinto "${path}"
1428 wolf31o2 1.164 newexe "${tmpwrapper}" "${wrapper}"
1429 vapier 1.283 ) || die
1430 wolf31o2 1.164 else
1431 vapier 1.283 newbin "${tmpwrapper}" "${wrapper}" || die
1432 wolf31o2 1.164 fi
1433 wolf31o2 1.160 }
1434 mr_bones_ 1.311
1435 vapier 1.351 # @FUNCTION: path_exists
1436     # @USAGE: [-a|-o] <paths>
1437     # @DESCRIPTION:
1438     # Check if the specified paths exist. Works for all types of paths
1439     # (files/dirs/etc...). The -a and -o flags control the requirements
1440     # of the paths. They correspond to "and" and "or" logic. So the -a
1441     # flag means all the paths must exist while the -o flag means at least
1442     # one of the paths must exist. The default behavior is "and". If no
1443     # paths are specified, then the return value is "false".
1444     path_exists() {
1445     local opt=$1
1446     [[ ${opt} == -[ao] ]] && shift || opt="-a"
1447    
1448     # no paths -> return false
1449     # same behavior as: [[ -e "" ]]
1450     [[ $# -eq 0 ]] && return 1
1451    
1452     local p r=0
1453     for p in "$@" ; do
1454     [[ -e ${p} ]]
1455     : $(( r += $? ))
1456     done
1457    
1458     case ${opt} in
1459     -a) return $(( r != 0 )) ;;
1460     -o) return $(( r == $# )) ;;
1461     esac
1462     }
1463 mgorny 1.364
1464     # @FUNCTION: in_iuse
1465     # @USAGE: <flag>
1466     # @DESCRIPTION:
1467     # Determines whether the given flag is in IUSE. Strips IUSE default prefixes
1468     # as necessary.
1469     #
1470     # Note that this function should not be used in the global scope.
1471     in_iuse() {
1472     debug-print-function ${FUNCNAME} "${@}"
1473     [[ ${#} -eq 1 ]] || die "Invalid args to ${FUNCNAME}()"
1474    
1475     local flag=${1}
1476     local liuse=( ${IUSE} )
1477    
1478     has "${flag}" "${liuse[@]#[+-]}"
1479     }
1480 vapier 1.365
1481 vapier 1.367 # @FUNCTION: use_if_iuse
1482     # @USAGE: <flag>
1483     # @DESCRIPTION:
1484     # Return true if the given flag is in USE and IUSE.
1485     #
1486     # Note that this function should not be used in the global scope.
1487     use_if_iuse() {
1488     in_iuse $1 || return 1
1489     use $1
1490     }
1491    
1492 vapier 1.365 # @FUNCTION: usex
1493     # @USAGE: <USE flag> [true output] [false output] [true suffix] [false suffix]
1494     # @DESCRIPTION:
1495     # If USE flag is set, echo [true output][true suffix] (defaults to "yes"),
1496     # otherwise echo [false output][false suffix] (defaults to "no").
1497     usex() { use "$1" && echo "${2-yes}$4" || echo "${3-no}$5" ; } #382963
1498 vapier 1.371
1499 vapier 1.372 check_license() { die "you no longer need this as portage supports ACCEPT_LICENSE itself"; }
1500    
1501 vapier 1.371 fi

  ViewVC Help
Powered by ViewVC 1.1.20