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

Contents of /eclass/eutils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.417 - (hide annotations) (download)
Thu Apr 25 18:38:02 2013 UTC (14 months, 4 weeks ago) by vapier
Branch: MAIN
Changes since 1.416: +5 -2 lines
epatch: handle aliased `patch` commands in a way that works with <=bash-3.2 #461568 by Michał Górny

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

  ViewVC Help
Powered by ViewVC 1.1.20