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

Contents of /eclass/eutils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.379 - (hide annotations) (download)
Tue Jan 31 06:44:00 2012 UTC (2 years, 5 months ago) by ulm
Branch: MAIN
Changes since 1.378: +2 -217 lines
Cdrom functions have been split out to dedicated cdrom.eclass. For the
time being, inherit cdrom; this can be removed once bug 398809 is fixed.

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 ulm 1.379 # $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.378 2012/01/31 06:36:19 ulm 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.379 inherit multilib cdrom 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     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 vapier 1.325 # @VARIABLE: EPATCH_SOURCE
223     # @DESCRIPTION:
224     # Default directory to search for patches.
225 azarah 1.2 EPATCH_SOURCE="${WORKDIR}/patch"
226 vapier 1.325 # @VARIABLE: EPATCH_SUFFIX
227     # @DESCRIPTION:
228     # Default extension for patches (do not prefix the period yourself).
229 azarah 1.2 EPATCH_SUFFIX="patch.bz2"
230 vapier 1.325 # @VARIABLE: EPATCH_OPTS
231     # @DESCRIPTION:
232     # Default options for patch:
233     # @CODE
234     # -g0 - keep RCS, ClearCase, Perforce and SCCS happy #24571
235     # --no-backup-if-mismatch - do not leave .orig files behind
236     # -E - automatically remove empty files
237     # @CODE
238 vapier 1.230 EPATCH_OPTS="-g0 -E --no-backup-if-mismatch"
239 vapier 1.325 # @VARIABLE: EPATCH_EXCLUDE
240     # @DESCRIPTION:
241 mr_bones_ 1.308 # List of patches not to apply. Note this is only file names,
242 vapier 1.325 # and not the full path. Globs accepted.
243 azarah 1.6 EPATCH_EXCLUDE=""
244 vapier 1.325 # @VARIABLE: EPATCH_SINGLE_MSG
245     # @DESCRIPTION:
246 azarah 1.9 # Change the printed message for a single patch.
247     EPATCH_SINGLE_MSG=""
248 vapier 1.325 # @VARIABLE: EPATCH_MULTI_MSG
249     # @DESCRIPTION:
250 vapier 1.173 # Change the printed message for multiple patches.
251     EPATCH_MULTI_MSG="Applying various patches (bugfixes/updates) ..."
252 vapier 1.325 # @VARIABLE: EPATCH_FORCE
253     # @DESCRIPTION:
254     # Only require patches to match EPATCH_SUFFIX rather than the extended
255     # arch naming style.
256 azarah 1.29 EPATCH_FORCE="no"
257 azarah 1.2
258 vapier 1.325 # @FUNCTION: epatch
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.
266 azarah 1.2 #
267 vapier 1.325 # If you do not specify any options, then epatch will default to the directory
268     # specified by EPATCH_SOURCE.
269 azarah 1.2 #
270 vapier 1.325 # When processing directories, epatch will apply all patches that match:
271     # @CODE
272 vapier 1.350 # if ${EPATCH_FORCE} != "yes"
273 vapier 1.325 # ??_${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.
282 azarah 1.2 #
283 vapier 1.325 # If EPATCH_SUFFIX is empty, then no period before it is implied when searching
284     # for patches to apply.
285 azarah 1.2 #
286 vapier 1.325 # Refer to the other EPATCH_xxx variables for more customization of behavior.
287 azarah 1.2 epatch() {
288 swegener 1.231 _epatch_draw_line() {
289 vapier 1.325 # create a line of same length as input string
290 agriffis 1.229 [[ -z $1 ]] && set "$(printf "%65s" '')"
291     echo "${1//?/=}"
292 vapier 1.219 }
293 azarah 1.3
294 vapier 1.195 unset P4CONFIG P4PORT P4USER # keep perforce at bay #56402
295    
296 vapier 1.325 # 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 vapier 1.94 for m in "$@" ; do
302     epatch "${m}"
303     done
304     return 0
305 azarah 1.3 fi
306    
307 vapier 1.325 local SINGLE_PATCH="no"
308     # no args means process ${EPATCH_SOURCE}
309     [[ $# -eq 0 ]] && set -- "${EPATCH_SOURCE}"
310    
311     if [[ -f $1 ]] ; then
312 azarah 1.3 SINGLE_PATCH="yes"
313 vapier 1.325 set -- "$1"
314     # Use the suffix from the single patch (localize it); the code
315     # below will find the suffix for us
316     local EPATCH_SUFFIX=$1
317    
318     elif [[ -d $1 ]] ; then
319     # Some people like to make dirs of patches w/out suffixes (vim)
320     set -- "$1"/*${EPATCH_SUFFIX:+."${EPATCH_SUFFIX}"}
321 danarmak 1.32
322 vapier 1.359 elif [[ -f ${EPATCH_SOURCE}/$1 ]] ; then
323     # Re-use EPATCH_SOURCE as a search dir
324     epatch "${EPATCH_SOURCE}/$1"
325     return $?
326    
327 azarah 1.3 else
328 vapier 1.325 # 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 azarah 1.3 fi
338 azarah 1.2
339 vapier 1.325 local PIPE_CMD
340 azarah 1.2 case ${EPATCH_SUFFIX##*\.} in
341 vapier 1.325 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 azarah 1.2 esac
348    
349 vapier 1.325 [[ ${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 flameeyes 1.266 # ???_arch_foo.patch
362 vapier 1.325 # Else, skip this input altogether
363     local a=${patchname#*_} # strip the ???_
364     a=${a%%_*} # strip the _foo.patch
365     if ! [[ ${SINGLE_PATCH} == "yes" || \
366 ulm 1.354 ${EPATCH_FORCE} == "yes" || \
367     ${a} == all || \
368     ${a} == ${ARCH} ]]
369 azarah 1.2 then
370 vapier 1.325 continue
371     fi
372 azarah 1.6
373 vapier 1.325 # 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 scarabeus 1.328 local ex
379 vapier 1.325 for ex in ${EPATCH_EXCLUDE} ; do
380 scarabeus 1.328 if [[ ${patchname} == ${ex} ]] ; then
381     eshopts_pop
382     continue 2
383     fi
384 vapier 1.325 done
385 vapier 1.326
386 vapier 1.325 eshopts_pop
387     fi
388 danarmak 1.32
389 vapier 1.325 if [[ ${SINGLE_PATCH} == "yes" ]] ; then
390     if [[ -n ${EPATCH_SINGLE_MSG} ]] ; then
391     einfo "${EPATCH_SINGLE_MSG}"
392 azarah 1.3 else
393 vapier 1.325 einfo "Applying ${patchname} ..."
394 azarah 1.3 fi
395 vapier 1.325 else
396     einfo " ${patchname} ..."
397     fi
398 azarah 1.2
399 vapier 1.325 # 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 azarah 1.2
406 vapier 1.369 printf "***** %s *****\nPWD: %s\n\n" "${patchname}" "${PWD}" > "${STDERR_TARGET}"
407 vapier 1.304
408 vapier 1.325 # 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 vapier 1.304
415 vapier 1.325 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
421 vapier 1.305 fi
422 vapier 1.325 else
423     PATCH_TARGET=${x}
424     fi
425 vapier 1.305
426 vapier 1.325 # 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 vapier 1.353 # 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 vapier 1.325
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 vapier 1.360 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 vapier 1.325 ) >> "${STDERR_TARGET}"
458 azarah 1.8
459 vapier 1.360 if [ $? -eq 0 ] ; then
460 vapier 1.325 (
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 vapier 1.360 ret=$?
468     echo
469     echo "patch program exited with status ${ret}"
470     exit ${ret}
471 vapier 1.325 ) >> "${STDERR_TARGET}"
472 danarmak 1.32
473 vapier 1.325 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 azarah 1.2 fi
480 vapier 1.325 break
481 azarah 1.8 fi
482    
483 vapier 1.325 : $(( count++ ))
484     done
485 azarah 1.8
486 vapier 1.325 # 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 azarah 1.3
491 vapier 1.325 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 azarah 1.2 fi
502 vapier 1.325
503     # if everything worked, delete the patch log
504     rm -f "${STDERR_TARGET}"
505     eend 0
506 azarah 1.2 done
507 vapier 1.325
508     [[ ${SINGLE_PATCH} == "no" ]] && einfo "Done with patching"
509     : # everything worked
510 azarah 1.26 }
511 vapier 1.361
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.
538 vapier 1.318 epatch_user() {
539     [[ $# -ne 0 ]] && die "epatch_user takes no options"
540    
541 vapier 1.361 # Allow multiple calls to this function; ignore all but the first
542 vapier 1.362 local applied="${T}/epatch_user.applied"
543 vapier 1.361 [[ -e ${applied} ]] && return 2
544    
545 vapier 1.318 # don't clobber any EPATCH vars that the parent might want
546 zmedico 1.323 local EPATCH_SOURCE check base=${PORTAGE_CONFIGROOT%/}/etc/portage/patches
547 ulm 1.378 for check in ${CATEGORY}/{${P}-${PR},${P},${PN}}; do
548 vapier 1.318 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 vapier 1.361 echo "${EPATCH_SOURCE}" > "${applied}"
558 vapier 1.349 return 0
559 vapier 1.318 fi
560     done
561 vapier 1.361 echo "none" > "${applied}"
562 vapier 1.349 return 1
563 vapier 1.318 }
564 azarah 1.26
565 vapier 1.283 # @FUNCTION: emktemp
566     # @USAGE: [temp dir]
567     # @DESCRIPTION:
568 vapier 1.52 # Cheap replacement for when debianutils (and thus mktemp)
569 vapier 1.283 # does not exist on the users system.
570 vapier 1.117 emktemp() {
571 vapier 1.119 local exe="touch"
572 vapier 1.194 [[ $1 == -d ]] && exe="mkdir" && shift
573     local topdir=$1
574 mr_bones_ 1.100
575 vapier 1.194 if [[ -z ${topdir} ]] ; then
576     [[ -z ${T} ]] \
577 vapier 1.117 && topdir="/tmp" \
578 vapier 1.194 || topdir=${T}
579 vapier 1.117 fi
580    
581 vapier 1.280 if ! type -P mktemp > /dev/null ; then
582     # system lacks `mktemp` so we have to fake it
583 vapier 1.117 local tmp=/
584 vapier 1.194 while [[ -e ${tmp} ]] ; do
585     tmp=${topdir}/tmp.${RANDOM}.${RANDOM}.${RANDOM}
586 vapier 1.117 done
587 vapier 1.194 ${exe} "${tmp}" || ${exe} -p "${tmp}"
588 vapier 1.117 echo "${tmp}"
589 vapier 1.52 else
590 vapier 1.280 # the args here will give slightly wierd names on BSD,
591     # but should produce a usable file on all userlands
592 flameeyes 1.223 if [[ ${exe} == "touch" ]] ; then
593 vapier 1.280 TMPDIR="${topdir}" mktemp -t tmp.XXXXXXXXXX
594 flameeyes 1.223 else
595 vapier 1.280 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX
596 flameeyes 1.223 fi
597 vapier 1.52 fi
598     }
599    
600 vapier 1.283 # @FUNCTION: edos2unix
601     # @USAGE: <file> [more files ...]
602     # @DESCRIPTION:
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.
607 vapier 1.24 edos2unix() {
608 vapier 1.366 [[ $# -eq 0 ]] && return 0
609     sed -i 's/\r$//' -- "$@" || die
610 vapier 1.39 }
611    
612 jlec 1.377 # @FUNCTION: make_desktop_entry
613     # @USAGE: make_desktop_entry(<command>, [name], [icon], [type], [fields])
614     # @DESCRIPTION:
615     # Make a .desktop file.
616     #
617     # @CODE
618     # binary: what command does the app run with ?
619     # name: the name that will show up in the menu
620     # icon: give your little like a pretty little icon ...
621     # this can be relative (to /usr/share/pixmaps) or
622     # a full path to an icon
623     # type: what kind of application is this?
624     # for categories:
625     # http://standards.freedesktop.org/menu-spec/latest/apa.html
626     # if unset, function tries to guess from package's category
627 vapier 1.341 # fields: extra fields to append to the desktop file; a printf string
628 jlec 1.377 # @CODE
629 vapier 1.39 make_desktop_entry() {
630 vapier 1.341 [[ -z $1 ]] && die "make_desktop_entry: You must specify the executable"
631 vapier 1.39
632 vapier 1.158 local exec=${1}
633     local name=${2:-${PN}}
634 wolf31o2 1.293 local icon=${3:-${PN}}
635 vapier 1.158 local type=${4}
636 vapier 1.341 local fields=${5}
637 vapier 1.158
638     if [[ -z ${type} ]] ; then
639     local catmaj=${CATEGORY%%-*}
640     local catmin=${CATEGORY##*-}
641     case ${catmaj} in
642     app)
643     case ${catmin} in
644 vapier 1.284 accessibility) type=Accessibility;;
645 vapier 1.338 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 vapier 1.158 esac
661 azarah 1.59 ;;
662 vapier 1.158
663     dev)
664 vapier 1.159 type="Development"
665 vapier 1.158 ;;
666    
667     games)
668     case ${catmin} in
669 wolf31o2 1.265 action|fps) type=ActionGame;;
670 vapier 1.338 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 vapier 1.158 simulation) type=Simulation;;
678 vapier 1.338 sports) type=SportsGame;;
679     strategy) type=StrategyGame;;
680 vapier 1.158 esac
681 vapier 1.159 type="Game;${type}"
682 vapier 1.158 ;;
683    
684 vapier 1.284 gnome)
685     type="Gnome;GTK"
686     ;;
687    
688     kde)
689     type="KDE;Qt"
690     ;;
691    
692 vapier 1.158 mail)
693 vapier 1.159 type="Network;Email"
694 vapier 1.158 ;;
695    
696     media)
697     case ${catmin} in
698 vapier 1.339 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 vapier 1.158 esac
711 wolf31o2 1.65 ;;
712 vapier 1.158
713     net)
714     case ${catmin} in
715     dialup) type=Dialup;;
716 vapier 1.338 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 vapier 1.158 esac
725 vapier 1.159 type="Network;${type}"
726 vapier 1.158 ;;
727    
728     sci)
729     case ${catmin} in
730 vapier 1.284 astro*) type=Astronomy;;
731 vapier 1.338 bio*) type=Biology;;
732     calc*) type=Calculator;;
733     chem*) type=Chemistry;;
734 vapier 1.284 elec*) type=Electronics;;
735 vapier 1.338 geo*) type=Geology;;
736     math*) type=Math;;
737 vapier 1.284 physics) type=Physics;;
738     visual*) type=DataVisualization;;
739 vapier 1.159 esac
740 abcd 1.336 type="Education;Science;${type}"
741 vapier 1.158 ;;
742    
743 vapier 1.284 sys)
744     type="System"
745     ;;
746    
747 vapier 1.158 www)
748     case ${catmin} in
749     client) type=WebBrowser;;
750     esac
751 abcd 1.336 type="Network;${type}"
752 azarah 1.59 ;;
753 vapier 1.158
754 azarah 1.59 *)
755     type=
756     ;;
757 vapier 1.39 esac
758     fi
759 carlo 1.177 if [ "${SLOT}" == "0" ] ; then
760     local desktop_name="${PN}"
761     else
762     local desktop_name="${PN}-${SLOT}"
763     fi
764 vapier 1.272 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop"
765 vapier 1.271 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop
766 vapier 1.39
767 abcd 1.336 # 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 vapier 1.271 cat <<-EOF > "${desktop}"
779     [Desktop Entry]
780     Name=${name}
781     Type=Application
782     Comment=${DESCRIPTION}
783     Exec=${exec}
784     TryExec=${exec%% *}
785     Icon=${icon}
786 abcd 1.336 Categories=${type}
787 vapier 1.271 EOF
788 vapier 1.39
789 vapier 1.341 if [[ ${fields:-=} != *=* ]] ; 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 vapier 1.342 [[ -n ${fields} ]] && printf '%b\n' "${fields}" >> "${desktop}"
795 wolf31o2 1.293
796 vapier 1.204 (
797     # wrap the env here so that the 'insinto' call
798     # doesn't corrupt the env of the caller
799     insinto /usr/share/applications
800     doins "${desktop}"
801 vapier 1.340 ) || die "installing desktop file failed"
802 danarmak 1.32 }
803    
804 vapier 1.283 # @FUNCTION: validate_desktop_entries
805     # @USAGE: [directories]
806     # @MAINTAINER:
807     # Carsten Lohrke <carlo@gentoo.org>
808     # @DESCRIPTION:
809 carlo 1.278 # Validate desktop entries using desktop-file-utils
810 carlo 1.277 validate_desktop_entries() {
811     if [[ -x /usr/bin/desktop-file-validate ]] ; then
812     einfo "Checking desktop entry validity"
813     local directories=""
814 carlo 1.279 for d in /usr/share/applications $@ ; do
815     [[ -d ${D}${d} ]] && directories="${directories} ${D}${d}"
816 carlo 1.277 done
817 carlo 1.279 if [[ -n ${directories} ]] ; then
818     for FILE in $(find ${directories} -name "*\.desktop" \
819     -not -path '*.hidden*' | sort -u 2>/dev/null)
820     do
821     local temp=$(desktop-file-validate ${FILE} | grep -v "warning:" | \
822     sed -e "s|error: ||" -e "s|${FILE}:|--|g" )
823     [[ -n $temp ]] && elog ${temp/--/${FILE/${D}/}:}
824     done
825     fi
826 carlo 1.277 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 vapier 1.283 # @FUNCTION: make_session_desktop
833 vapier 1.314 # @USAGE: <title> <command> [command args...]
834 vapier 1.283 # @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 vapier 1.314 #
838     # You can set the name of the file via the ${wm} variable.
839 lanius 1.133 make_session_desktop() {
840 vapier 1.314 [[ -z $1 ]] && eerror "$0: You must specify the title" && return 1
841     [[ -z $2 ]] && eerror "$0: You must specify the command" && return 1
842 lanius 1.133
843 vapier 1.167 local title=$1
844     local command=$2
845 vapier 1.314 local desktop=${T}/${wm:-${PN}}.desktop
846     shift 2
847 lanius 1.133
848 vapier 1.271 cat <<-EOF > "${desktop}"
849     [Desktop Entry]
850     Name=${title}
851     Comment=This session logs you into ${title}
852 vapier 1.314 Exec=${command} $*
853 vapier 1.271 TryExec=${command}
854 vapier 1.314 Type=XSession
855 vapier 1.271 EOF
856 lanius 1.133
857 vapier 1.271 (
858     # wrap the env here so that the 'insinto' call
859     # doesn't corrupt the env of the caller
860 lanius 1.133 insinto /usr/share/xsessions
861     doins "${desktop}"
862 vapier 1.271 )
863 lanius 1.133 }
864    
865 vapier 1.283 # @FUNCTION: domenu
866     # @USAGE: <menus>
867     # @DESCRIPTION:
868     # Install the list of .desktop menu files into the appropriate directory
869     # (/usr/share/applications).
870 lanius 1.133 domenu() {
871 vapier 1.271 (
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 lanius 1.133 insinto /usr/share/applications
876 vapier 1.167 for i in "$@" ; do
877     if [[ -f ${i} ]] ; then
878     doins "${i}"
879 vapier 1.271 ((ret+=$?))
880 vapier 1.167 elif [[ -d ${i} ]] ; then
881     for j in "${i}"/*.desktop ; do
882     doins "${j}"
883 vapier 1.271 ((ret+=$?))
884 lanius 1.133 done
885 vapier 1.285 else
886     ((++ret))
887 swegener 1.190 fi
888 lanius 1.133 done
889 vapier 1.271 exit ${ret}
890     )
891 lanius 1.133 }
892 vapier 1.283
893     # @FUNCTION: newmenu
894     # @USAGE: <menu> <newname>
895     # @DESCRIPTION:
896     # Like all other new* functions, install the specified menu as newname.
897 vapier 1.167 newmenu() {
898 vapier 1.271 (
899     # wrap the env here so that the 'insinto' call
900     # doesn't corrupt the env of the caller
901 vapier 1.167 insinto /usr/share/applications
902 vapier 1.271 newins "$@"
903     )
904 vapier 1.167 }
905 lanius 1.133
906 vapier 1.283 # @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.
911 lanius 1.133 doicon() {
912 vapier 1.271 (
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 lanius 1.133 insinto /usr/share/pixmaps
917 vapier 1.167 for i in "$@" ; do
918     if [[ -f ${i} ]] ; then
919     doins "${i}"
920 vapier 1.271 ((ret+=$?))
921 vapier 1.167 elif [[ -d ${i} ]] ; then
922     for j in "${i}"/*.png ; do
923     doins "${j}"
924 vapier 1.271 ((ret+=$?))
925 lanius 1.133 done
926 vapier 1.285 else
927     ((++ret))
928 swegener 1.190 fi
929 lanius 1.133 done
930 vapier 1.271 exit ${ret}
931     )
932 lanius 1.133 }
933 vapier 1.283
934     # @FUNCTION: newicon
935     # @USAGE: <icon> <newname>
936     # @DESCRIPTION:
937     # Like all other new* functions, install the specified icon as newname.
938 vapier 1.167 newicon() {
939 vapier 1.271 (
940     # wrap the env here so that the 'insinto' call
941     # doesn't corrupt the env of the caller
942 vapier 1.167 insinto /usr/share/pixmaps
943 vapier 1.271 newins "$@"
944     )
945 vapier 1.167 }
946 lanius 1.133
947 vapier 1.70 # for internal use only (unpack_pdv and unpack_makeself)
948     find_unpackable_file() {
949 vapier 1.196 local src=$1
950     if [[ -z ${src} ]] ; then
951     src=${DISTDIR}/${A}
952 vapier 1.50 else
953 vapier 1.196 if [[ -e ${DISTDIR}/${src} ]] ; then
954     src=${DISTDIR}/${src}
955     elif [[ -e ${PWD}/${src} ]] ; then
956     src=${PWD}/${src}
957     elif [[ -e ${src} ]] ; then
958     src=${src}
959 vapier 1.50 fi
960     fi
961 vapier 1.196 [[ ! -e ${src} ]] && return 1
962 vapier 1.70 echo "${src}"
963     }
964    
965 vapier 1.283 # @FUNCTION: unpack_pdv
966     # @USAGE: <file to unpack> <size of off_t>
967     # @DESCRIPTION:
968 vapier 1.70 # Unpack those pesky pdv generated files ...
969     # They're self-unpacking programs with the binary package stuffed in
970     # the middle of the archive. Valve seems to use it a lot ... too bad
971     # it seems to like to segfault a lot :(. So lets take it apart ourselves.
972 swegener 1.286 #
973 vapier 1.283 # You have to specify the off_t size ... I have no idea how to extract that
974     # information out of the binary executable myself. Basically you pass in
975     # the size of the off_t type (in bytes) on the machine that built the pdv
976     # archive.
977 vapier 1.70 #
978 vapier 1.283 # One way to determine this is by running the following commands:
979 ulm 1.288 #
980     # @CODE
981     # strings <pdv archive> | grep lseek
982     # strace -elseek <pdv archive>
983     # @CODE
984     #
985 vapier 1.283 # Basically look for the first lseek command (we do the strings/grep because
986     # sometimes the function call is _llseek or something) and steal the 2nd
987     # parameter. Here is an example:
988 ulm 1.288 #
989     # @CODE
990     # vapier@vapier 0 pdv_unpack # strings hldsupdatetool.bin | grep lseek
991     # lseek
992     # vapier@vapier 0 pdv_unpack # strace -elseek ./hldsupdatetool.bin
993     # lseek(3, -4, SEEK_END) = 2981250
994     # @CODE
995     #
996 vapier 1.283 # Thus we would pass in the value of '4' as the second parameter.
997 vapier 1.70 unpack_pdv() {
998 vapier 1.271 local src=$(find_unpackable_file "$1")
999 vapier 1.196 local sizeoff_t=$2
1000 vapier 1.70
1001 vapier 1.196 [[ -z ${src} ]] && die "Could not locate source for '$1'"
1002     [[ -z ${sizeoff_t} ]] && die "No idea what off_t size was used for this pdv :("
1003 vapier 1.70
1004 vapier 1.212 local shrtsrc=$(basename "${src}")
1005 vapier 1.70 echo ">>> Unpacking ${shrtsrc} to ${PWD}"
1006 vapier 1.271 local metaskip=$(tail -c ${sizeoff_t} "${src}" | hexdump -e \"%i\")
1007     local tailskip=$(tail -c $((${sizeoff_t}*2)) "${src}" | head -c ${sizeoff_t} | hexdump -e \"%i\")
1008 vapier 1.70
1009     # grab metadata for debug reasons
1010 vapier 1.271 local metafile=$(emktemp)
1011     tail -c +$((${metaskip}+1)) "${src}" > "${metafile}"
1012 vapier 1.70
1013     # rip out the final file name from the metadata
1014 vapier 1.271 local datafile=$(tail -c +$((${metaskip}+1)) "${src}" | strings | head -n 1)
1015     datafile=$(basename "${datafile}")
1016 vapier 1.70
1017 vapier 1.71 # now lets uncompress/untar the file if need be
1018 vapier 1.271 local tmpfile=$(emktemp)
1019 vapier 1.70 tail -c +$((${tailskip}+1)) ${src} 2>/dev/null | head -c 512 > ${tmpfile}
1020 vapier 1.71
1021 vapier 1.271 local iscompressed=$(file -b "${tmpfile}")
1022     if [[ ${iscompressed:0:8} == "compress" ]] ; then
1023 vapier 1.71 iscompressed=1
1024     mv ${tmpfile}{,.Z}
1025     gunzip ${tmpfile}
1026     else
1027     iscompressed=0
1028     fi
1029 vapier 1.271 local istar=$(file -b "${tmpfile}")
1030     if [[ ${istar:0:9} == "POSIX tar" ]] ; then
1031 vapier 1.71 istar=1
1032     else
1033     istar=0
1034     fi
1035    
1036     #for some reason gzip dies with this ... dd cant provide buffer fast enough ?
1037     #dd if=${src} ibs=${metaskip} count=1 \
1038     # | dd ibs=${tailskip} skip=1 \
1039     # | gzip -dc \
1040     # > ${datafile}
1041     if [ ${iscompressed} -eq 1 ] ; then
1042     if [ ${istar} -eq 1 ] ; then
1043     tail -c +$((${tailskip}+1)) ${src} 2>/dev/null \
1044     | head -c $((${metaskip}-${tailskip})) \
1045     | tar -xzf -
1046     else
1047 vapier 1.70 tail -c +$((${tailskip}+1)) ${src} 2>/dev/null \
1048     | head -c $((${metaskip}-${tailskip})) \
1049     | gzip -dc \
1050     > ${datafile}
1051 vapier 1.71 fi
1052     else
1053     if [ ${istar} -eq 1 ] ; then
1054     tail -c +$((${tailskip}+1)) ${src} 2>/dev/null \
1055     | head -c $((${metaskip}-${tailskip})) \
1056 vapier 1.73 | tar --no-same-owner -xf -
1057 vapier 1.71 else
1058 vapier 1.70 tail -c +$((${tailskip}+1)) ${src} 2>/dev/null \
1059     | head -c $((${metaskip}-${tailskip})) \
1060     > ${datafile}
1061 vapier 1.71 fi
1062     fi
1063     true
1064     #[ -s "${datafile}" ] || die "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
1065 vapier 1.70 #assert "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
1066     }
1067    
1068 vapier 1.283 # @FUNCTION: unpack_makeself
1069     # @USAGE: [file to unpack] [offset] [tail|dd]
1070     # @DESCRIPTION:
1071 vapier 1.70 # Unpack those pesky makeself generated files ...
1072     # They're shell scripts with the binary package tagged onto
1073     # the end of the archive. Loki utilized the format as does
1074     # many other game companies.
1075 swegener 1.286 #
1076 vapier 1.283 # If the file is not specified, then ${A} is used. If the
1077     # offset is not specified then we will attempt to extract
1078     # the proper offset from the script itself.
1079 vapier 1.70 unpack_makeself() {
1080 vapier 1.217 local src_input=${1:-${A}}
1081     local src=$(find_unpackable_file "${src_input}")
1082 vapier 1.196 local skip=$2
1083     local exe=$3
1084    
1085 vapier 1.217 [[ -z ${src} ]] && die "Could not locate source for '${src_input}'"
1086 vapier 1.50
1087 vapier 1.196 local shrtsrc=$(basename "${src}")
1088 vapier 1.41 echo ">>> Unpacking ${shrtsrc} to ${PWD}"
1089 vapier 1.212 if [[ -z ${skip} ]] ; then
1090 mr_bones_ 1.343 local ver=$(grep -m1 -a '#.*Makeself' "${src}" | awk '{print $NF}')
1091 vapier 1.41 local skip=0
1092 vapier 1.112 exe=tail
1093 vapier 1.41 case ${ver} in
1094 wolf31o2 1.240 1.5.*|1.6.0-nv) # tested 1.5.{3,4,5} ... guessing 1.5.x series is same
1095 vapier 1.112 skip=$(grep -a ^skip= "${src}" | cut -d= -f2)
1096 vapier 1.41 ;;
1097     2.0|2.0.1)
1098 vapier 1.112 skip=$(grep -a ^$'\t'tail "${src}" | awk '{print $2}' | cut -b2-)
1099 vapier 1.41 ;;
1100 wolf31o2 1.48 2.1.1)
1101 vapier 1.112 skip=$(grep -a ^offset= "${src}" | awk '{print $2}' | cut -b2-)
1102 vapier 1.344 (( skip++ ))
1103 wolf31o2 1.48 ;;
1104 vapier 1.49 2.1.2)
1105 vapier 1.112 skip=$(grep -a ^offset= "${src}" | awk '{print $3}' | head -n 1)
1106 vapier 1.344 (( skip++ ))
1107 vapier 1.49 ;;
1108 wolf31o2 1.48 2.1.3)
1109 vapier 1.112 skip=`grep -a ^offset= "${src}" | awk '{print $3}'`
1110 vapier 1.344 (( skip++ ))
1111 vapier 1.41 ;;
1112 wolf31o2 1.211 2.1.4|2.1.5)
1113 vapier 1.112 skip=$(grep -a offset=.*head.*wc "${src}" | awk '{print $3}' | head -n 1)
1114     skip=$(head -n ${skip} "${src}" | wc -c)
1115     exe="dd"
1116     ;;
1117 vapier 1.41 *)
1118     eerror "I'm sorry, but I was unable to support the Makeself file."
1119     eerror "The version I detected was '${ver}'."
1120     eerror "Please file a bug about the file ${shrtsrc} at"
1121     eerror "http://bugs.gentoo.org/ so that support can be added."
1122     die "makeself version '${ver}' not supported"
1123     ;;
1124     esac
1125     debug-print "Detected Makeself version ${ver} ... using ${skip} as offset"
1126     fi
1127 vapier 1.112 case ${exe} in
1128     tail) exe="tail -n +${skip} '${src}'";;
1129 vapier 1.344 dd) exe="dd ibs=${skip} skip=1 if='${src}'";;
1130 vapier 1.112 *) die "makeself cant handle exe '${exe}'"
1131     esac
1132 vapier 1.41
1133 vapier 1.68 # lets grab the first few bytes of the file to figure out what kind of archive it is
1134 vapier 1.356 local filetype tmpfile=$(emktemp)
1135 vapier 1.112 eval ${exe} 2>/dev/null | head -c 512 > "${tmpfile}"
1136 vapier 1.356 filetype=$(file -b "${tmpfile}") || die
1137 vapier 1.68 case ${filetype} in
1138 vapier 1.257 *tar\ archive*)
1139 vapier 1.112 eval ${exe} | tar --no-same-owner -xf -
1140 vapier 1.68 ;;
1141     bzip2*)
1142 vapier 1.112 eval ${exe} | bzip2 -dc | tar --no-same-owner -xf -
1143 mr_bones_ 1.69 ;;
1144 vapier 1.68 gzip*)
1145 vapier 1.112 eval ${exe} | tar --no-same-owner -xzf -
1146 vapier 1.68 ;;
1147 vapier 1.93 compress*)
1148 vapier 1.112 eval ${exe} | gunzip | tar --no-same-owner -xf -
1149 vapier 1.93 ;;
1150 vapier 1.68 *)
1151 vapier 1.93 eerror "Unknown filetype \"${filetype}\" ?"
1152 vapier 1.68 false
1153     ;;
1154     esac
1155     assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})"
1156 wolf31o2 1.56 }
1157    
1158 vapier 1.287 # @FUNCTION: strip-linguas
1159     # @USAGE: [<allow LINGUAS>|<-i|-u> <directories of .po files>]
1160     # @DESCRIPTION:
1161 mr_bones_ 1.100 # Make sure that LINGUAS only contains languages that
1162 vapier 1.287 # a package can support. The first form allows you to
1163     # specify a list of LINGUAS. The -i builds a list of po
1164     # files found in all the directories and uses the
1165     # intersection of the lists. The -u builds a list of po
1166     # files found in all the directories and uses the union
1167     # of the lists.
1168 vapier 1.92 strip-linguas() {
1169 vapier 1.242 local ls newls nols
1170 vapier 1.154 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then
1171     local op=$1; shift
1172 vapier 1.315 ls=$(find "$1" -name '*.po' -exec basename {} .po ';'); shift
1173 vapier 1.92 local d f
1174     for d in "$@" ; do
1175 vapier 1.154 if [[ ${op} == "-u" ]] ; then
1176     newls=${ls}
1177 vapier 1.92 else
1178     newls=""
1179     fi
1180 vapier 1.315 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do
1181 vapier 1.154 if [[ ${op} == "-i" ]] ; then
1182 ssuominen 1.358 has ${f} ${ls} && newls="${newls} ${f}"
1183 vapier 1.92 else
1184 ssuominen 1.358 has ${f} ${ls} || newls="${newls} ${f}"
1185 vapier 1.92 fi
1186     done
1187 vapier 1.154 ls=${newls}
1188 vapier 1.92 done
1189     else
1190 vapier 1.236 ls="$@"
1191 vapier 1.92 fi
1192    
1193 vapier 1.242 nols=""
1194 vapier 1.92 newls=""
1195     for f in ${LINGUAS} ; do
1196 ssuominen 1.358 if has ${f} ${ls} ; then
1197 vapier 1.120 newls="${newls} ${f}"
1198 vapier 1.92 else
1199 vapier 1.242 nols="${nols} ${f}"
1200 vapier 1.92 fi
1201     done
1202 vapier 1.244 [[ -n ${nols} ]] \
1203 vapier 1.316 && ewarn "Sorry, but ${PN} does not support the LINGUAS:" ${nols}
1204 vapier 1.237 export LINGUAS=${newls:1}
1205 vapier 1.92 }
1206 iggy 1.110
1207 vapier 1.283 # @FUNCTION: preserve_old_lib
1208     # @USAGE: <libs to preserve> [more libs]
1209     # @DESCRIPTION:
1210     # These functions are useful when a lib in your package changes ABI SONAME.
1211     # An example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0
1212 eradicator 1.111 # would break packages that link against it. Most people get around this
1213     # by using the portage SLOT mechanism, but that is not always a relevant
1214 vapier 1.283 # solution, so instead you can call this from pkg_preinst. See also the
1215     # preserve_old_lib_notify function.
1216 eradicator 1.111 preserve_old_lib() {
1217 vapier 1.268 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then
1218 vapier 1.267 eerror "preserve_old_lib() must be called from pkg_preinst() only"
1219 vapier 1.276 die "Invalid preserve_old_lib() usage"
1220 vapier 1.267 fi
1221     [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]"
1222    
1223 vapier 1.297 # let portage worry about it
1224     has preserve-libs ${FEATURES} && return 0
1225    
1226 vapier 1.267 local lib dir
1227     for lib in "$@" ; do
1228     [[ -e ${ROOT}/${lib} ]] || continue
1229     dir=${lib%/*}
1230     dodir ${dir} || die "dodir ${dir} failed"
1231     cp "${ROOT}"/${lib} "${D}"/${lib} || die "cp ${lib} failed"
1232     touch "${D}"/${lib}
1233     done
1234 eradicator 1.111 }
1235    
1236 vapier 1.283 # @FUNCTION: preserve_old_lib_notify
1237     # @USAGE: <libs to notify> [more libs]
1238     # @DESCRIPTION:
1239     # Spit helpful messages about the libraries preserved by preserve_old_lib.
1240 eradicator 1.111 preserve_old_lib_notify() {
1241 vapier 1.268 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then
1242 vapier 1.267 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only"
1243 vapier 1.276 die "Invalid preserve_old_lib_notify() usage"
1244 vapier 1.267 fi
1245    
1246 vapier 1.297 # let portage worry about it
1247     has preserve-libs ${FEATURES} && return 0
1248    
1249 vapier 1.267 local lib notice=0
1250     for lib in "$@" ; do
1251     [[ -e ${ROOT}/${lib} ]] || continue
1252     if [[ ${notice} -eq 0 ]] ; then
1253     notice=1
1254     ewarn "Old versions of installed libraries were detected on your system."
1255     ewarn "In order to avoid breaking packages that depend on these old libs,"
1256     ewarn "the libraries are not being removed. You need to run revdep-rebuild"
1257     ewarn "in order to remove these old dependencies. If you do not have this"
1258     ewarn "helper program, simply emerge the 'gentoolkit' package."
1259     ewarn
1260     fi
1261 vapier 1.355 # temp hack for #348634 #357225
1262     [[ ${PN} == "mpfr" ]] && lib=${lib##*/}
1263 vapier 1.352 ewarn " # revdep-rebuild --library '${lib}'"
1264 vapier 1.267 done
1265 vapier 1.291 if [[ ${notice} -eq 1 ]] ; then
1266     ewarn
1267     ewarn "Once you've finished running revdep-rebuild, it should be safe to"
1268 vapier 1.300 ewarn "delete the old libraries. Here is a copy & paste for the lazy:"
1269     for lib in "$@" ; do
1270     ewarn " # rm '${lib}'"
1271     done
1272 vapier 1.291 fi
1273 eradicator 1.111 }
1274 vapier 1.125
1275 vapier 1.283 # @FUNCTION: built_with_use
1276     # @USAGE: [--hidden] [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags>
1277     # @DESCRIPTION:
1278 betelgeuse 1.329 #
1279     # Deprecated: Use EAPI 2 use deps in DEPEND|RDEPEND and with has_version calls.
1280     #
1281 vapier 1.283 # A temporary hack until portage properly supports DEPENDing on USE
1282     # flags being enabled in packages. This will check to see if the specified
1283     # DEPEND atom was built with the specified list of USE flags. The
1284     # --missing option controls the behavior if called on a package that does
1285     # not actually support the defined USE flags (aka listed in IUSE).
1286     # The default is to abort (call die). The -a and -o flags control
1287     # the requirements of the USE flags. They correspond to "and" and "or"
1288     # logic. So the -a flag means all listed USE flags must be enabled
1289 opfer 1.302 # while the -o flag means at least one of the listed IUSE flags must be
1290 vapier 1.283 # enabled. The --hidden option is really for internal use only as it
1291     # means the USE flag we're checking is hidden expanded, so it won't be found
1292     # in IUSE like normal USE flags.
1293 swegener 1.286 #
1294 vapier 1.283 # Remember that this function isn't terribly intelligent so order of optional
1295     # flags matter.
1296 vapier 1.125 built_with_use() {
1297 vapier 1.275 local hidden="no"
1298     if [[ $1 == "--hidden" ]] ; then
1299     hidden="yes"
1300     shift
1301     fi
1302    
1303 vapier 1.269 local missing_action="die"
1304     if [[ $1 == "--missing" ]] ; then
1305     missing_action=$2
1306     shift ; shift
1307     case ${missing_action} in
1308     true|false|die) ;;
1309     *) die "unknown action '${missing_action}'";;
1310     esac
1311     fi
1312    
1313 vapier 1.130 local opt=$1
1314     [[ ${opt:0:1} = "-" ]] && shift || opt="-a"
1315    
1316     local PKG=$(best_version $1)
1317 vapier 1.247 [[ -z ${PKG} ]] && die "Unable to resolve $1 to an installed package"
1318 vapier 1.130 shift
1319    
1320 vapier 1.213 local USEFILE=${ROOT}/var/db/pkg/${PKG}/USE
1321 vapier 1.249 local IUSEFILE=${ROOT}/var/db/pkg/${PKG}/IUSE
1322 vapier 1.213
1323 cardoe 1.273 # if the IUSE file doesn't exist, the read will error out, we need to handle
1324     # this gracefully
1325 vapier 1.275 if [[ ! -e ${USEFILE} ]] || [[ ! -e ${IUSEFILE} && ${hidden} == "no" ]] ; then
1326 cardoe 1.273 case ${missing_action} in
1327     true) return 0;;
1328     false) return 1;;
1329     die) die "Unable to determine what USE flags $PKG was built with";;
1330     esac
1331     fi
1332    
1333 vapier 1.275 if [[ ${hidden} == "no" ]] ; then
1334 zmedico 1.301 local IUSE_BUILT=( $(<"${IUSEFILE}") )
1335 vapier 1.275 # Don't check USE_EXPAND #147237
1336     local expand
1337     for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do
1338     if [[ $1 == ${expand}_* ]] ; then
1339     expand=""
1340     break
1341     fi
1342     done
1343     if [[ -n ${expand} ]] ; then
1344 zmedico 1.301 if ! has $1 ${IUSE_BUILT[@]#[-+]} ; then
1345 vapier 1.275 case ${missing_action} in
1346     true) return 0;;
1347     false) return 1;;
1348     die) die "$PKG does not actually support the $1 USE flag!";;
1349     esac
1350     fi
1351 vapier 1.269 fi
1352 vapier 1.250 fi
1353 vapier 1.249
1354 vapier 1.125 local USE_BUILT=$(<${USEFILE})
1355 vapier 1.130 while [[ $# -gt 0 ]] ; do
1356     if [[ ${opt} = "-o" ]] ; then
1357     has $1 ${USE_BUILT} && return 0
1358     else
1359     has $1 ${USE_BUILT} || return 1
1360     fi
1361 vapier 1.125 shift
1362     done
1363 vapier 1.130 [[ ${opt} = "-a" ]]
1364 vapier 1.125 }
1365 vapier 1.126
1366 vapier 1.289 # @FUNCTION: epunt_cxx
1367 vapier 1.283 # @USAGE: [dir to scan]
1368     # @DESCRIPTION:
1369     # Many configure scripts wrongly bail when a C++ compiler could not be
1370     # detected. If dir is not specified, then it defaults to ${S}.
1371     #
1372     # http://bugs.gentoo.org/73450
1373 vapier 1.126 epunt_cxx() {
1374 vapier 1.127 local dir=$1
1375     [[ -z ${dir} ]] && dir=${S}
1376     ebegin "Removing useless C++ checks"
1377     local f
1378 vapier 1.294 find "${dir}" -name configure | while read f ; do
1379     patch --no-backup-if-mismatch -p0 "${f}" "${PORTDIR}/eclass/ELT-patches/nocxx/nocxx.patch" > /dev/null
1380 vapier 1.127 done
1381     eend 0
1382 vapier 1.126 }
1383 ka0ttic 1.143
1384 vapier 1.283 # @FUNCTION: make_wrapper
1385 wolf31o2 1.295 # @USAGE: <wrapper> <target> [chdir] [libpaths] [installpath]
1386 vapier 1.283 # @DESCRIPTION:
1387     # Create a shell wrapper script named wrapper in installpath
1388     # (defaults to the bindir) to execute target (default of wrapper) by
1389     # first optionally setting LD_LIBRARY_PATH to the colon-delimited
1390     # libpaths followed by optionally changing directory to chdir.
1391 wolf31o2 1.160 make_wrapper() {
1392 wolf31o2 1.164 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5
1393 wolf31o2 1.160 local tmpwrapper=$(emktemp)
1394 vapier 1.202 # We don't want to quote ${bin} so that people can pass complex
1395     # things as $bin ... "./someprog --args"
1396 wolf31o2 1.160 cat << EOF > "${tmpwrapper}"
1397     #!/bin/sh
1398 vapier 1.201 cd "${chdir:-.}"
1399 vapier 1.210 if [ -n "${libdir}" ] ; then
1400     if [ "\${LD_LIBRARY_PATH+set}" = "set" ] ; then
1401     export LD_LIBRARY_PATH="\${LD_LIBRARY_PATH}:${libdir}"
1402     else
1403     export LD_LIBRARY_PATH="${libdir}"
1404     fi
1405 vapier 1.201 fi
1406 vapier 1.202 exec ${bin} "\$@"
1407 wolf31o2 1.160 EOF
1408     chmod go+rx "${tmpwrapper}"
1409 vapier 1.201 if [[ -n ${path} ]] ; then
1410 vapier 1.283 (
1411 vapier 1.201 exeinto "${path}"
1412 wolf31o2 1.164 newexe "${tmpwrapper}" "${wrapper}"
1413 vapier 1.283 ) || die
1414 wolf31o2 1.164 else
1415 vapier 1.283 newbin "${tmpwrapper}" "${wrapper}" || die
1416 wolf31o2 1.164 fi
1417 wolf31o2 1.160 }
1418 mr_bones_ 1.311
1419 vapier 1.351 # @FUNCTION: path_exists
1420     # @USAGE: [-a|-o] <paths>
1421     # @DESCRIPTION:
1422     # Check if the specified paths exist. Works for all types of paths
1423     # (files/dirs/etc...). The -a and -o flags control the requirements
1424     # of the paths. They correspond to "and" and "or" logic. So the -a
1425     # flag means all the paths must exist while the -o flag means at least
1426     # one of the paths must exist. The default behavior is "and". If no
1427     # paths are specified, then the return value is "false".
1428     path_exists() {
1429     local opt=$1
1430     [[ ${opt} == -[ao] ]] && shift || opt="-a"
1431    
1432     # no paths -> return false
1433     # same behavior as: [[ -e "" ]]
1434     [[ $# -eq 0 ]] && return 1
1435    
1436     local p r=0
1437     for p in "$@" ; do
1438     [[ -e ${p} ]]
1439     : $(( r += $? ))
1440     done
1441    
1442     case ${opt} in
1443     -a) return $(( r != 0 )) ;;
1444     -o) return $(( r == $# )) ;;
1445     esac
1446     }
1447 mgorny 1.364
1448     # @FUNCTION: in_iuse
1449     # @USAGE: <flag>
1450     # @DESCRIPTION:
1451     # Determines whether the given flag is in IUSE. Strips IUSE default prefixes
1452     # as necessary.
1453     #
1454     # Note that this function should not be used in the global scope.
1455     in_iuse() {
1456     debug-print-function ${FUNCNAME} "${@}"
1457     [[ ${#} -eq 1 ]] || die "Invalid args to ${FUNCNAME}()"
1458    
1459     local flag=${1}
1460     local liuse=( ${IUSE} )
1461    
1462     has "${flag}" "${liuse[@]#[+-]}"
1463     }
1464 vapier 1.365
1465 vapier 1.367 # @FUNCTION: use_if_iuse
1466     # @USAGE: <flag>
1467     # @DESCRIPTION:
1468     # Return true if the given flag is in USE and IUSE.
1469     #
1470     # Note that this function should not be used in the global scope.
1471     use_if_iuse() {
1472     in_iuse $1 || return 1
1473     use $1
1474     }
1475    
1476 vapier 1.365 # @FUNCTION: usex
1477     # @USAGE: <USE flag> [true output] [false output] [true suffix] [false suffix]
1478     # @DESCRIPTION:
1479     # If USE flag is set, echo [true output][true suffix] (defaults to "yes"),
1480     # otherwise echo [false output][false suffix] (defaults to "no").
1481     usex() { use "$1" && echo "${2-yes}$4" || echo "${3-no}$5" ; } #382963
1482 vapier 1.371
1483 vapier 1.372 check_license() { die "you no longer need this as portage supports ACCEPT_LICENSE itself"; }
1484    
1485 vapier 1.371 fi

  ViewVC Help
Powered by ViewVC 1.1.20