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

Diff of /eclass/eutils.eclass

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

Revision 1.279 Revision 1.345
1# Copyright 1999-2006 Gentoo Foundation 1# Copyright 1999-2009 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.279 2007/04/25 09:14:35 carlo Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.345 2010/06/23 21:24:50 cardoe Exp $
4
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.
4# 14#
5# This eclass is for general purpose functions that most ebuilds 15# Due to the nature of this eclass, some functions may have maintainers
6# have to implement themselves. 16# different from the overall eclass!
7#
8# NB: If you add anything, please comment it!
9#
10# Maintainer: see each individual function, base-system@gentoo.org as default
11 17
12inherit multilib portability 18inherit multilib portability
13 19
14DESCRIPTION="Based on the ${ECLASS} eclass" 20DESCRIPTION="Based on the ${ECLASS} eclass"
15 21
16# Wait for the supplied number of seconds. If no argument is supplied, defaults 22if has "${EAPI:-0}" 0 1 2; then
17# to five seconds. If the EPAUSE_IGNORE env var is set, don't wait. If we're not 23
18# outputting to a terminal, don't wait. For compatability purposes, the argument 24# @FUNCTION: epause
19# must be an integer greater than zero. 25# @USAGE: [seconds]
20# Bug 62950, Ciaran McCreesh <ciaranm@gentoo.org> (05 Sep 2004) 26# @DESCRIPTION:
27# Sleep for the specified number of seconds (default of 5 seconds). Useful when
28# printing a message the user should probably be reading and often used in
29# conjunction with the ebeep function. If the EPAUSE_IGNORE env var is set,
30# don't wait at all. Defined in EAPIs 0 1 and 2.
21epause() { 31epause() {
22 [[ -z ${EPAUSE_IGNORE} ]] && sleep ${1:-5} 32 [[ -z ${EPAUSE_IGNORE} ]] && sleep ${1:-5}
23} 33}
24 34
25# Beep the specified number of times (defaults to five). If our output 35# @FUNCTION: ebeep
26# is not a terminal, don't beep. If the EBEEP_IGNORE env var is set, 36# @USAGE: [number of beeps]
27# don't beep. 37# @DESCRIPTION:
28# Bug 62950, Ciaran McCreesh <ciaranm@gentoo.org> (05 Sep 2004) 38# Issue the specified number of beeps (default of 5 beeps). Useful when
39# printing a message the user should probably be reading and often used in
40# conjunction with the epause function. If the EBEEP_IGNORE env var is set,
41# don't beep at all. Defined in EAPIs 0 1 and 2.
29ebeep() { 42ebeep() {
30 local n 43 local n
31 if [[ -z ${EBEEP_IGNORE} ]] ; then 44 if [[ -z ${EBEEP_IGNORE} ]] ; then
32 for ((n=1 ; n <= ${1:-5} ; n++)) ; do 45 for ((n=1 ; n <= ${1:-5} ; n++)) ; do
33 echo -ne "\a" 46 echo -ne "\a"
36 sleep 1 49 sleep 1
37 done 50 done
38 fi 51 fi
39} 52}
40 53
41# This function generate linker scripts in /usr/lib for dynamic 54else
42# libs in /lib. This is to fix linking problems when you have 55
43# the .so in /lib, and the .a in /usr/lib. What happens is that 56ebeep() {
44# in some cases when linking dynamic, the .a in /usr/lib is used 57 ewarn "QA Notice: ebeep is not defined in EAPI=${EAPI}, please file a bug at http://bugs.gentoo.org"
45# instead of the .so in /lib due to gcc/libtool tweaking ld's 58}
46# library search path. This cause many builds to fail. 59
47# See bug #4411 for more info. 60epause() {
48# 61 ewarn "QA Notice: epause is not defined in EAPI=${EAPI}, please file a bug at http://bugs.gentoo.org"
49# To use, simply call: 62}
50# 63
51# gen_usr_ldscript libfoo.so
52#
53# Note that you should in general use the unversioned name of
54# the library, as ldconfig should usually update it correctly
55# to point to the latest version of the library present.
56#
57# <azarah@gentoo.org> (26 Oct 2002)
58#
59gen_usr_ldscript() {
60 if [[ $(type -t _tc_gen_usr_ldscript) == "function" ]] ; then
61 _tc_gen_usr_ldscript "$@"
62 return $?
63 fi 64fi
64 65
65 ewarn "QA Notice: Please upgrade your ebuild to use toolchain-funcs" 66# @FUNCTION: ecvs_clean
66 ewarn "QA Notice: rather than gen_usr_ldscript() from eutils" 67# @USAGE: [list of dirs]
68# @DESCRIPTION:
69# Remove CVS directories recursiveley. Useful when a source tarball contains
70# internal CVS directories. Defaults to $PWD.
71ecvs_clean() {
72 [[ -z $* ]] && set -- .
73 find "$@" -type d -name 'CVS' -prune -print0 | xargs -0 rm -rf
74 find "$@" -type f -name '.cvs*' -print0 | xargs -0 rm -rf
75}
67 76
68 local lib libdir=$(get_libdir) 77# @FUNCTION: esvn_clean
69 # Just make sure it exists 78# @USAGE: [list of dirs]
70 dodir /usr/${libdir} 79# @DESCRIPTION:
80# Remove .svn directories recursiveley. Useful when a source tarball contains
81# internal Subversion directories. Defaults to $PWD.
82esvn_clean() {
83 [[ -z $* ]] && set -- .
84 find "$@" -type d -name '.svn' -prune -print0 | xargs -0 rm -rf
85}
71 86
72 for lib in "${@}" ; do 87# @FUNCTION: eshopts_push
73 cat > "${D}/usr/${libdir}/${lib}" <<-END_LDSCRIPT 88# @USAGE: [options to `set` or `shopt`]
74 /* GNU ld script 89# @DESCRIPTION:
75 Since Gentoo has critical dynamic libraries 90# Often times code will want to enable a shell option to change code behavior.
76 in /lib, and the static versions in /usr/lib, 91# Since changing shell options can easily break other pieces of code (which
77 we need to have a "fake" dynamic lib in /usr/lib, 92# assume the default state), eshopts_push is used to (1) push the current shell
78 otherwise we run into linking problems. 93# options onto a stack and (2) pass the specified arguments to set.
79 94#
80 See bug http://bugs.gentoo.org/4411 for more info. 95# If the first argument is '-s' or '-u', we assume you want to call `shopt`
81 */ 96# rather than `set` as there are some options only available via that.
82 GROUP ( /${libdir}/${lib} ) 97#
83 END_LDSCRIPT 98# A common example is to disable shell globbing so that special meaning/care
84 fperms a+x "/usr/${libdir}/${lib}" || die "could not change perms on ${lib}" 99# may be used with variables/arguments to custom functions. That would be:
100# @CODE
101# eshopts_push -o noglob
102# for x in ${foo} ; do
103# if ...some check... ; then
104# eshopts_pop
105# return 0
106# fi
85 done 107# done
108# eshopts_pop
109# @CODE
110eshopts_push() {
111 # have to assume __ESHOPTS_SAVE__ isn't screwed with
112 # as a `declare -a` here will reset its value
113 local i=${#__ESHOPTS_SAVE__[@]}
114 if [[ $1 == -[su] ]] ; then
115 __ESHOPTS_SAVE__[$i]=$(shopt -p)
116 [[ $# -eq 0 ]] && return 0
117 shopt "$@" || die "eshopts_push: bad options to shopt: $*"
118 else
119 __ESHOPTS_SAVE__[$i]=$-
120 [[ $# -eq 0 ]] && return 0
121 set "$@" || die "eshopts_push: bad options to set: $*"
122 fi
86} 123}
87 124
125# @FUNCTION: eshopts_pop
126# @USAGE:
127# @DESCRIPTION:
128# Restore the shell options to the state saved with the corresponding
129# eshopts_push call. See that function for more details.
130eshopts_pop() {
131 [[ $# -ne 0 ]] && die "eshopts_pop takes no arguments"
132 local i=$(( ${#__ESHOPTS_SAVE__[@]} - 1 ))
133 [[ ${i} -eq -1 ]] && die "eshopts_{push,pop}: unbalanced pair"
134 local s=${__ESHOPTS_SAVE__[$i]}
135 unset __ESHOPTS_SAVE__[$i]
136 if [[ ${s} == "shopt -"* ]] ; then
137 eval "${s}" || die "eshopts_pop: sanity: invalid shopt options: ${s}"
138 else
139 set +$- || die "eshopts_pop: sanity: invalid shell settings: $-"
140 set -${s} || die "eshopts_pop: sanity: unable to restore saved shell settings: ${s}"
141 fi
142}
88 143
89# Default directory where patches are located 144# @VARIABLE: EPATCH_SOURCE
145# @DESCRIPTION:
146# Default directory to search for patches.
90EPATCH_SOURCE="${WORKDIR}/patch" 147EPATCH_SOURCE="${WORKDIR}/patch"
91# Default extension for patches 148# @VARIABLE: EPATCH_SUFFIX
149# @DESCRIPTION:
150# Default extension for patches (do not prefix the period yourself).
92EPATCH_SUFFIX="patch.bz2" 151EPATCH_SUFFIX="patch.bz2"
152# @VARIABLE: EPATCH_OPTS
153# @DESCRIPTION:
93# Default options for patch 154# Default options for patch:
155# @CODE
94# Set -g0 to keep RCS, ClearCase, Perforce and SCCS happy. Bug #24571 156# -g0 - keep RCS, ClearCase, Perforce and SCCS happy #24571
95# Set --no-backup-if-mismatch so we don't leave '.orig' files behind. 157# --no-backup-if-mismatch - do not leave .orig files behind
96# Set -E to automatically remove empty files. 158# -E - automatically remove empty files
159# @CODE
97EPATCH_OPTS="-g0 -E --no-backup-if-mismatch" 160EPATCH_OPTS="-g0 -E --no-backup-if-mismatch"
161# @VARIABLE: EPATCH_EXCLUDE
162# @DESCRIPTION:
98# List of patches not to apply. Not this is only file names, 163# List of patches not to apply. Note this is only file names,
99# and not the full path .. 164# and not the full path. Globs accepted.
100EPATCH_EXCLUDE="" 165EPATCH_EXCLUDE=""
166# @VARIABLE: EPATCH_SINGLE_MSG
167# @DESCRIPTION:
101# Change the printed message for a single patch. 168# Change the printed message for a single patch.
102EPATCH_SINGLE_MSG="" 169EPATCH_SINGLE_MSG=""
170# @VARIABLE: EPATCH_MULTI_MSG
171# @DESCRIPTION:
103# Change the printed message for multiple patches. 172# Change the printed message for multiple patches.
104EPATCH_MULTI_MSG="Applying various patches (bugfixes/updates) ..." 173EPATCH_MULTI_MSG="Applying various patches (bugfixes/updates) ..."
105# Force applying bulk patches even if not following the style: 174# @VARIABLE: EPATCH_FORCE
106# 175# @DESCRIPTION:
107# ??_${ARCH}_foo.${EPATCH_SUFFIX} 176# Only require patches to match EPATCH_SUFFIX rather than the extended
108# 177# arch naming style.
109EPATCH_FORCE="no" 178EPATCH_FORCE="no"
110 179
111# This function is for bulk patching, or in theory for just one 180# @FUNCTION: epatch
112# or two patches. 181# @USAGE: [patches] [dirs of patches]
182# @DESCRIPTION:
183# epatch is designed to greatly simplify the application of patches. It can
184# process patch files directly, or directories of patches. The patches may be
185# compressed (bzip/gzip/etc...) or plain text. You generally need not specify
186# the -p option as epatch will automatically attempt -p0 to -p5 until things
187# apply successfully.
113# 188#
114# It should work with .bz2, .gz, .zip and plain text patches. 189# If you do not specify any options, then epatch will default to the directory
115# Currently all patches should be the same format. 190# specified by EPATCH_SOURCE.
116# 191#
117# You do not have to specify '-p' option to patch, as it will 192# When processing directories, epatch will apply all patches that match:
118# try with -p0 to -p5 until it succeed, or fail at -p5. 193# @CODE
119# 194# ${EPATCH_FORCE} == "yes"
120# Above EPATCH_* variables can be used to control various defaults,
121# bug they should be left as is to ensure an ebuild can rely on
122# them for.
123#
124# Patches are applied in current directory.
125#
126# Bulk Patches should preferibly have the form of:
127#
128# ??_${ARCH}_foo.${EPATCH_SUFFIX} 195# ??_${ARCH}_foo.${EPATCH_SUFFIX}
196# else
197# *.${EPATCH_SUFFIX}
198# @CODE
199# The leading ?? are typically numbers used to force consistent patch ordering.
200# The arch field is used to apply patches only for the host architecture with
201# the special value of "all" means apply for everyone. Note that using values
202# other than "all" is highly discouraged -- you should apply patches all the
203# time and let architecture details be detected at configure/compile time.
129# 204#
130# For example: 205# If EPATCH_SUFFIX is empty, then no period before it is implied when searching
206# for patches to apply.
131# 207#
132# 01_all_misc-fix.patch.bz2 208# Refer to the other EPATCH_xxx variables for more customization of behavior.
133# 02_sparc_another-fix.patch.bz2
134#
135# This ensures that there are a set order, and you can have ARCH
136# specific patches.
137#
138# If you however give an argument to epatch(), it will treat it as a
139# single patch that need to be applied if its a file. If on the other
140# hand its a directory, it will set EPATCH_SOURCE to this.
141#
142# <azarah@gentoo.org> (10 Nov 2002)
143#
144epatch() { 209epatch() {
145 _epatch_draw_line() { 210 _epatch_draw_line() {
211 # create a line of same length as input string
146 [[ -z $1 ]] && set "$(printf "%65s" '')" 212 [[ -z $1 ]] && set "$(printf "%65s" '')"
147 echo "${1//?/=}" 213 echo "${1//?/=}"
148 } 214 }
149 _epatch_assert() { local _pipestatus=${PIPESTATUS[*]}; [[ ${_pipestatus// /} -eq 0 ]] ; }
150 local PIPE_CMD=""
151 local STDERR_TARGET="${T}/$$.out"
152 local PATCH_TARGET="${T}/$$.patch"
153 local PATCH_SUFFIX=""
154 local SINGLE_PATCH="no"
155 local x=""
156 215
157 unset P4CONFIG P4PORT P4USER # keep perforce at bay #56402 216 unset P4CONFIG P4PORT P4USER # keep perforce at bay #56402
158 217
159 if [ "$#" -gt 1 ] 218 # Let the rest of the code process one user arg at a time --
160 then 219 # each arg may expand into multiple patches, and each arg may
220 # need to start off with the default global EPATCH_xxx values
221 if [[ $# -gt 1 ]] ; then
161 local m="" 222 local m
162 for m in "$@" ; do 223 for m in "$@" ; do
163 epatch "${m}" 224 epatch "${m}"
164 done 225 done
165 return 0 226 return 0
166 fi 227 fi
167 228
168 if [ -n "$1" -a -f "$1" ] 229 local SINGLE_PATCH="no"
169 then 230 # no args means process ${EPATCH_SOURCE}
231 [[ $# -eq 0 ]] && set -- "${EPATCH_SOURCE}"
232
233 if [[ -f $1 ]] ; then
170 SINGLE_PATCH="yes" 234 SINGLE_PATCH="yes"
171 235 set -- "$1"
172 local EPATCH_SOURCE="$1" 236 # Use the suffix from the single patch (localize it); the code
237 # below will find the suffix for us
173 local EPATCH_SUFFIX="${1##*\.}" 238 local EPATCH_SUFFIX=$1
174 239
175 elif [ -n "$1" -a -d "$1" ] 240 elif [[ -d $1 ]] ; then
176 then 241 # Some people like to make dirs of patches w/out suffixes (vim)
177 # Allow no extension if EPATCH_FORCE=yes ... used by vim for example ... 242 set -- "$1"/*${EPATCH_SUFFIX:+."${EPATCH_SUFFIX}"}
178 if [ "${EPATCH_FORCE}" = "yes" ] && [ -z "${EPATCH_SUFFIX}" ] 243
244 else
245 # sanity check ... if it isn't a dir or file, wtf man ?
246 [[ $# -ne 0 ]] && EPATCH_SOURCE=$1
247 echo
248 eerror "Cannot find \$EPATCH_SOURCE! Value for \$EPATCH_SOURCE is:"
249 eerror
250 eerror " ${EPATCH_SOURCE}"
251 eerror " ( ${EPATCH_SOURCE##*/} )"
252 echo
253 die "Cannot find \$EPATCH_SOURCE!"
254 fi
255
256 local PIPE_CMD
257 case ${EPATCH_SUFFIX##*\.} in
258 xz) PIPE_CMD="xz -dc" ;;
259 lzma) PIPE_CMD="lzma -dc" ;;
260 bz2) PIPE_CMD="bzip2 -dc" ;;
261 gz|Z|z) PIPE_CMD="gzip -dc" ;;
262 ZIP|zip) PIPE_CMD="unzip -p" ;;
263 *) ;;
264 esac
265
266 [[ ${SINGLE_PATCH} == "no" ]] && einfo "${EPATCH_MULTI_MSG}"
267
268 local x
269 for x in "$@" ; do
270 # If the patch dir given contains subdirs, or our EPATCH_SUFFIX
271 # didn't match anything, ignore continue on
272 [[ ! -f ${x} ]] && continue
273
274 local patchname=${x##*/}
275
276 # Apply single patches, or forced sets of patches, or
277 # patches with ARCH dependant names.
278 # ???_arch_foo.patch
279 # Else, skip this input altogether
280 local a=${patchname#*_} # strip the ???_
281 a=${a%%_*} # strip the _foo.patch
282 if ! [[ ${SINGLE_PATCH} == "yes" || \
283 ${EPATCH_FORCE} == "yes" || \
284 ${a} == all || \
285 ${a} == ${ARCH} ]]
179 then 286 then
180 local EPATCH_SOURCE="$1/*" 287 continue
288 fi
289
290 # Let people filter things dynamically
291 if [[ -n ${EPATCH_EXCLUDE} ]] ; then
292 # let people use globs in the exclude
293 eshopts_push -o noglob
294
295 local ex
296 for ex in ${EPATCH_EXCLUDE} ; do
297 if [[ ${patchname} == ${ex} ]] ; then
298 eshopts_pop
299 continue 2
300 fi
301 done
302
303 eshopts_pop
304 fi
305
306 if [[ ${SINGLE_PATCH} == "yes" ]] ; then
307 if [[ -n ${EPATCH_SINGLE_MSG} ]] ; then
308 einfo "${EPATCH_SINGLE_MSG}"
309 else
310 einfo "Applying ${patchname} ..."
311 fi
181 else 312 else
182 local EPATCH_SOURCE="$1/*.${EPATCH_SUFFIX}" 313 einfo " ${patchname} ..."
183 fi 314 fi
184 else 315
185 if [ ! -d ${EPATCH_SOURCE} ] || [ -n "$1" ] 316 # most of the time, there will only be one run per unique name,
186 then 317 # but if there are more, make sure we get unique log filenames
187 if [ -n "$1" -a "${EPATCH_SOURCE}" = "${WORKDIR}/patch" ] 318 local STDERR_TARGET="${T}/${patchname}.out"
188 then 319 if [[ -e ${STDERR_TARGET} ]] ; then
189 EPATCH_SOURCE="$1" 320 STDERR_TARGET="${T}/${patchname}-$$.out"
321 fi
322
323 printf "***** %s *****\n\n" "${patchname}" > "${STDERR_TARGET}"
324
325 # Decompress the patch if need be
326 local count=0
327 local PATCH_TARGET
328 if [[ -n ${PIPE_CMD} ]] ; then
329 PATCH_TARGET="${T}/$$.patch"
330 echo "PIPE_COMMAND: ${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> "${STDERR_TARGET}"
331
332 if ! (${PIPE_CMD} "${x}" > "${PATCH_TARGET}") >> "${STDERR_TARGET}" 2>&1 ; then
333 echo
334 eerror "Could not extract patch!"
335 #die "Could not extract patch!"
336 count=5
337 break
190 fi 338 fi
339 else
340 PATCH_TARGET=${x}
341 fi
191 342
343 # Check for absolute paths in patches. If sandbox is disabled,
344 # people could (accidently) patch files in the root filesystem.
345 # Or trigger other unpleasantries #237667. So disallow -p0 on
346 # such patches.
347 local abs_paths=$(egrep -n '^[-+]{3} /' "${PATCH_TARGET}" | awk '$2 != "/dev/null" { print }')
348 if [[ -n ${abs_paths} ]] ; then
349 count=1
350 printf "NOTE: skipping -p0 due to absolute paths in patch:\n%s\n" "${abs_paths}" >> "${STDERR_TARGET}"
351 fi
352
353 # Dynamically detect the correct -p# ... i'm lazy, so shoot me :/
354 while [[ ${count} -lt 5 ]] ; do
355 # Generate some useful debug info ...
356 (
357 _epatch_draw_line "***** ${patchname} *****"
192 echo 358 echo
193 eerror "Cannot find \$EPATCH_SOURCE! Value for \$EPATCH_SOURCE is:" 359 echo "PATCH COMMAND: patch -p${count} ${EPATCH_OPTS} < '${PATCH_TARGET}'"
360 echo
361 _epatch_draw_line "***** ${patchname} *****"
362 ) >> "${STDERR_TARGET}"
363
364 if (patch -p${count} ${EPATCH_OPTS} --dry-run -f < "${PATCH_TARGET}") >> "${STDERR_TARGET}" 2>&1 ; then
365 (
366 _epatch_draw_line "***** ${patchname} *****"
367 echo
368 echo "ACTUALLY APPLYING ${patchname} ..."
369 echo
370 _epatch_draw_line "***** ${patchname} *****"
371 patch -p${count} ${EPATCH_OPTS} < "${PATCH_TARGET}" 2>&1
372 ) >> "${STDERR_TARGET}"
373
374 if [ $? -ne 0 ] ; then
375 echo
376 eerror "A dry-run of patch command succeeded, but actually"
377 eerror "applying the patch failed!"
378 #die "Real world sux compared to the dreamworld!"
379 count=5
380 fi
381 break
382 fi
383
384 : $(( count++ ))
385 done
386
387 # if we had to decompress the patch, delete the temp one
388 if [[ -n ${PIPE_CMD} ]] ; then
389 rm -f "${PATCH_TARGET}"
390 fi
391
392 if [[ ${count} -ge 5 ]] ; then
393 echo
394 eerror "Failed Patch: ${patchname} !"
395 eerror " ( ${PATCH_TARGET} )"
194 eerror 396 eerror
195 eerror " ${EPATCH_SOURCE}" 397 eerror "Include in your bugreport the contents of:"
196 eerror " ( ${EPATCH_SOURCE##*/} )" 398 eerror
399 eerror " ${STDERR_TARGET}"
197 echo 400 echo
198 die "Cannot find \$EPATCH_SOURCE!"
199 fi
200
201 local EPATCH_SOURCE="${EPATCH_SOURCE}/*.${EPATCH_SUFFIX}"
202 fi
203
204 case ${EPATCH_SUFFIX##*\.} in
205 bz2)
206 PIPE_CMD="bzip2 -dc"
207 PATCH_SUFFIX="bz2"
208 ;;
209 gz|Z|z)
210 PIPE_CMD="gzip -dc"
211 PATCH_SUFFIX="gz"
212 ;;
213 ZIP|zip)
214 PIPE_CMD="unzip -p"
215 PATCH_SUFFIX="zip"
216 ;;
217 *)
218 PIPE_CMD="cat"
219 PATCH_SUFFIX="patch"
220 ;;
221 esac
222
223 if [ "${SINGLE_PATCH}" = "no" ]
224 then
225 einfo "${EPATCH_MULTI_MSG}"
226 fi
227 for x in ${EPATCH_SOURCE}
228 do
229 # New ARCH dependant patch naming scheme ...
230 #
231 # ???_arch_foo.patch
232 #
233 if [ -f ${x} ] && \
234 ([ "${SINGLE_PATCH}" = "yes" -o "${x/_all_}" != "${x}" -o "${x/_${ARCH}_}" != "${x}" ] || \
235 [ "${EPATCH_FORCE}" = "yes" ])
236 then
237 local count=0
238 local popts="${EPATCH_OPTS}"
239 local patchname=${x##*/}
240
241 if [ -n "${EPATCH_EXCLUDE}" ]
242 then
243 if [ "${EPATCH_EXCLUDE/${patchname}}" != "${EPATCH_EXCLUDE}" ]
244 then
245 continue
246 fi
247 fi
248
249 if [ "${SINGLE_PATCH}" = "yes" ]
250 then
251 if [ -n "${EPATCH_SINGLE_MSG}" ]
252 then
253 einfo "${EPATCH_SINGLE_MSG}"
254 else
255 einfo "Applying ${patchname} ..."
256 fi
257 else
258 einfo " ${patchname} ..."
259 fi
260
261 echo "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
262 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
263
264 # Allow for prefix to differ ... im lazy, so shoot me :/
265 while [ "${count}" -lt 5 ]
266 do
267 # Generate some useful debug info ...
268 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
269 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
270
271 if [ "${PATCH_SUFFIX}" != "patch" ]
272 then
273 echo -n "PIPE_COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
274 echo "${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
275 else
276 PATCH_TARGET="${x}"
277 fi
278
279 echo -n "PATCH COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
280 echo "patch -p${count} ${popts} < ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
281
282 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
283 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
284
285 if [ "${PATCH_SUFFIX}" != "patch" ]
286 then
287 if ! (${PIPE_CMD} ${x} > ${PATCH_TARGET}) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1
288 then
289 echo
290 eerror "Could not extract patch!"
291 #die "Could not extract patch!"
292 count=5
293 break
294 fi
295 fi
296
297 if (cat ${PATCH_TARGET} | patch -p${count} ${popts} --dry-run -f ; _epatch_assert) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1
298 then
299 _epatch_draw_line "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
300 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
301 echo "ACTUALLY APPLYING ${patchname} ..." >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
302 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
303 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
304
305 cat ${PATCH_TARGET} | patch -p${count} ${popts} >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real 2>&1
306 _epatch_assert
307
308 if [ "$?" -ne 0 ]
309 then
310 cat ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
311 echo
312 eerror "A dry-run of patch command succeeded, but actually"
313 eerror "applying the patch failed!"
314 #die "Real world sux compared to the dreamworld!"
315 count=5
316 fi
317
318 rm -f ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
319
320 break
321 fi
322
323 count=$((count + 1))
324 done
325
326 if [ "${PATCH_SUFFIX}" != "patch" ]
327 then
328 rm -f ${PATCH_TARGET}
329 fi
330
331 if [ "${count}" -eq 5 ]
332 then
333 echo
334 eerror "Failed Patch: ${patchname} !"
335 eerror " ( ${PATCH_TARGET} )"
336 eerror
337 eerror "Include in your bugreport the contents of:"
338 eerror
339 eerror " ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}"
340 echo
341 die "Failed Patch: ${patchname}!" 401 die "Failed Patch: ${patchname}!"
342 fi 402 fi
343 403
344 rm -f ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 404 # if everything worked, delete the patch log
345 405 rm -f "${STDERR_TARGET}"
346 eend 0 406 eend 0
347 fi
348 done 407 done
349 if [ "${SINGLE_PATCH}" = "no" ] 408
350 then 409 [[ ${SINGLE_PATCH} == "no" ]] && einfo "Done with patching"
351 einfo "Done with patching" 410 : # everything worked
411}
412epatch_user() {
413 [[ $# -ne 0 ]] && die "epatch_user takes no options"
414
415 # don't clobber any EPATCH vars that the parent might want
416 local EPATCH_SOURCE check base=${PORTAGE_CONFIGROOT%/}/etc/portage/patches
417 for check in {${CATEGORY}/${PF},${CATEGORY}/${P},${CATEGORY}/${PN}}; do
418 EPATCH_SOURCE=${base}/${CTARGET}/${check}
419 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${CHOST}/${check}
420 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${check}
421 if [[ -d ${EPATCH_SOURCE} ]] ; then
422 EPATCH_SOURCE=${EPATCH_SOURCE} \
423 EPATCH_SUFFIX="patch" \
424 EPATCH_FORCE="yes" \
425 EPATCH_MULTI_MSG="Applying user patches from ${EPATCH_SOURCE} ..." \
426 epatch
427 break
352 fi 428 fi
429 done
353} 430}
354 431
432# @FUNCTION: emktemp
433# @USAGE: [temp dir]
434# @DESCRIPTION:
355# Cheap replacement for when debianutils (and thus mktemp) 435# Cheap replacement for when debianutils (and thus mktemp)
356# does not exist on the users system 436# does not exist on the users system.
357# vapier@gentoo.org
358#
359# Takes just 1 optional parameter (the directory to create tmpfile in)
360emktemp() { 437emktemp() {
361 local exe="touch" 438 local exe="touch"
362 [[ $1 == -d ]] && exe="mkdir" && shift 439 [[ $1 == -d ]] && exe="mkdir" && shift
363 local topdir=$1 440 local topdir=$1
364 441
366 [[ -z ${T} ]] \ 443 [[ -z ${T} ]] \
367 && topdir="/tmp" \ 444 && topdir="/tmp" \
368 || topdir=${T} 445 || topdir=${T}
369 fi 446 fi
370 447
371 if [[ -z $(type -p mktemp) ]] ; then 448 if ! type -P mktemp > /dev/null ; then
449 # system lacks `mktemp` so we have to fake it
372 local tmp=/ 450 local tmp=/
373 while [[ -e ${tmp} ]] ; do 451 while [[ -e ${tmp} ]] ; do
374 tmp=${topdir}/tmp.${RANDOM}.${RANDOM}.${RANDOM} 452 tmp=${topdir}/tmp.${RANDOM}.${RANDOM}.${RANDOM}
375 done 453 done
376 ${exe} "${tmp}" || ${exe} -p "${tmp}" 454 ${exe} "${tmp}" || ${exe} -p "${tmp}"
377 echo "${tmp}" 455 echo "${tmp}"
378 else 456 else
457 # the args here will give slightly wierd names on BSD,
458 # but should produce a usable file on all userlands
379 if [[ ${exe} == "touch" ]] ; then 459 if [[ ${exe} == "touch" ]] ; then
380 [[ ${USERLAND} == "GNU" ]] \
381 && mktemp -p "${topdir}" \
382 || TMPDIR="${topdir}" mktemp -t tmp 460 TMPDIR="${topdir}" mktemp -t tmp.XXXXXXXXXX
383 else 461 else
384 [[ ${USERLAND} == "GNU" ]] \
385 && mktemp -d "${topdir}" \
386 || TMPDIR="${topdir}" mktemp -dt tmp 462 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX
387 fi
388 fi 463 fi
464 fi
389} 465}
390 466
467# @FUNCTION: egetent
468# @USAGE: <database> <key>
469# @MAINTAINER:
470# base-system@gentoo.org (Linux)
471# Joe Jezak <josejx@gmail.com> (OS X)
472# usata@gentoo.org (OS X)
473# Aaron Walker <ka0ttic@gentoo.org> (FreeBSD)
474# @DESCRIPTION:
391# Small wrapper for getent (Linux), nidump (Mac OS X), 475# Small wrapper for getent (Linux),
476# nidump (< Mac OS X 10.5), dscl (Mac OS X 10.5),
392# and pw (FreeBSD) used in enewuser()/enewgroup() 477# and pw (FreeBSD) used in enewuser()/enewgroup()
393# Joe Jezak <josejx@gmail.com> and usata@gentoo.org
394# FBSD stuff: Aaron Walker <ka0ttic@gentoo.org>
395#
396# egetent(database, key)
397egetent() { 478egetent() {
398 case ${CHOST} in 479 case ${CHOST} in
399 *-darwin*) 480 *-darwin[678])
400 case "$2" in 481 case "$2" in
401 *[!0-9]*) # Non numeric 482 *[!0-9]*) # Non numeric
402 nidump $1 . | awk -F":" "{ if (\$1 ~ /^$2$/) {print \$0;exit;} }" 483 nidump $1 . | awk -F":" "{ if (\$1 ~ /^$2$/) {print \$0;exit;} }"
403 ;; 484 ;;
404 *) # Numeric 485 *) # Numeric
405 nidump $1 . | awk -F":" "{ if (\$3 == $2) {print \$0;exit;} }" 486 nidump $1 . | awk -F":" "{ if (\$3 == $2) {print \$0;exit;} }"
487 ;;
488 esac
489 ;;
490 *-darwin*)
491 local mytype=$1
492 [[ "passwd" == $mytype ]] && mytype="Users"
493 [[ "group" == $mytype ]] && mytype="Groups"
494 case "$2" in
495 *[!0-9]*) # Non numeric
496 dscl . -read /$mytype/$2 2>/dev/null |grep RecordName
497 ;;
498 *) # Numeric
499 local mykey="UniqueID"
500 [[ $mytype == "Groups" ]] && mykey="PrimaryGroupID"
501 dscl . -search /$mytype $mykey $2 2>/dev/null
406 ;; 502 ;;
407 esac 503 esac
408 ;; 504 ;;
409 *-freebsd*|*-dragonfly*) 505 *-freebsd*|*-dragonfly*)
410 local opts action="user" 506 local opts action="user"
425 getent "$1" "$2" 521 getent "$1" "$2"
426 ;; 522 ;;
427 esac 523 esac
428} 524}
429 525
430# Simplify/standardize adding users to the system 526# @FUNCTION: enewuser
431# vapier@gentoo.org 527# @USAGE: <user> [uid] [shell] [homedir] [groups] [params]
432# 528# @DESCRIPTION:
433# enewuser(username, uid, shell, homedir, groups, extra options) 529# Same as enewgroup, you are not required to understand how to properly add
434# 530# a user to the system. The only required parameter is the username.
435# Default values if you do not specify any: 531# Default uid is (pass -1 for this) next available, default shell is
436# username: REQUIRED ! 532# /bin/false, default homedir is /dev/null, there are no default groups,
437# uid: next available (see useradd(8)) 533# and default params sets the comment as 'added by portage for ${PN}'.
438# note: pass -1 to get default behavior
439# shell: /bin/false
440# homedir: /dev/null
441# groups: none
442# extra: comment of 'added by portage for ${PN}'
443enewuser() { 534enewuser() {
444 case ${EBUILD_PHASE} in 535 case ${EBUILD_PHASE} in
445 unpack|compile|test|install) 536 unpack|compile|test|install)
446 eerror "'enewuser()' called from '${EBUILD_PHASE}()' which is not a pkg_* function." 537 eerror "'enewuser()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
447 eerror "Package fails at QA and at life. Please file a bug." 538 eerror "Package fails at QA and at life. Please file a bug."
615 fi 706 fi
616 ;; 707 ;;
617 708
618 *) 709 *)
619 if [[ -z $@ ]] ; then 710 if [[ -z $@ ]] ; then
620 useradd ${opts} ${euser} \ 711 useradd -r ${opts} \
621 -c "added by portage for ${PN}" \ 712 -c "added by portage for ${PN}" \
713 ${euser} \
622 || die "enewuser failed" 714 || die "enewuser failed"
623 else 715 else
624 einfo " - Extra: $@" 716 einfo " - Extra: $@"
625 useradd ${opts} ${euser} "$@" \ 717 useradd -r ${opts} "$@" \
718 ${euser} \
626 || die "enewuser failed" 719 || die "enewuser failed"
627 fi 720 fi
628 ;; 721 ;;
629 esac 722 esac
630 723
636 fi 729 fi
637 730
638 export SANDBOX_ON=${oldsandbox} 731 export SANDBOX_ON=${oldsandbox}
639} 732}
640 733
641# Simplify/standardize adding groups to the system 734# @FUNCTION: enewgroup
642# vapier@gentoo.org 735# @USAGE: <group> [gid]
643# 736# @DESCRIPTION:
644# enewgroup(group, gid) 737# This function does not require you to understand how to properly add a
645# 738# group to the system. Just give it a group name to add and enewgroup will
646# Default values if you do not specify any: 739# do the rest. You may specify the gid for the group or allow the group to
647# groupname: REQUIRED ! 740# allocate the next available one.
648# gid: next available (see groupadd(8))
649# extra: none
650enewgroup() { 741enewgroup() {
651 case ${EBUILD_PHASE} in 742 case ${EBUILD_PHASE} in
652 unpack|compile|test|install) 743 unpack|compile|test|install)
653 eerror "'enewgroup()' called from '${EBUILD_PHASE}()' which is not a pkg_* function." 744 eerror "'enewgroup()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
654 eerror "Package fails at QA and at life. Please file a bug." 745 eerror "Package fails at QA and at life. Please file a bug."
744 esac 835 esac
745 groupadd -g ${egid} ${egroup} || die "enewgroup failed" 836 groupadd -g ${egid} ${egroup} || die "enewgroup failed"
746 ;; 837 ;;
747 838
748 *) 839 *)
840 # We specify -r so that we get a GID in the system range from login.defs
749 groupadd ${opts} ${egroup} || die "enewgroup failed" 841 groupadd -r ${opts} ${egroup} || die "enewgroup failed"
750 ;; 842 ;;
751 esac 843 esac
752 export SANDBOX_ON="${oldsandbox}" 844 export SANDBOX_ON="${oldsandbox}"
753} 845}
754 846
755# Simple script to replace 'dos2unix' binaries 847# @FUNCTION: edos2unix
756# vapier@gentoo.org 848# @USAGE: <file> [more files ...]
757# 849# @DESCRIPTION:
758# edos2unix(file, <more files> ...) 850# A handy replacement for dos2unix, recode, fixdos, etc... This allows you
851# to remove all of these text utilities from DEPEND variables because this
852# is a script based solution. Just give it a list of files to convert and
853# they will all be changed from the DOS CRLF format to the UNIX LF format.
759edos2unix() { 854edos2unix() {
760 echo "$@" | xargs sed -i 's/\r$//' 855 echo "$@" | xargs sed -i 's/\r$//'
761} 856}
762
763
764##############################################################
765# START: Handle .desktop files and menu entries #
766# maybe this should be separated into a new eclass some time #
767# lanius@gentoo.org #
768##############################################################
769 857
770# Make a desktop file ! 858# Make a desktop file !
771# Great for making those icons in kde/gnome startmenu ! 859# Great for making those icons in kde/gnome startmenu !
772# Amaze your friends ! Get the women ! Join today ! 860# Amaze your friends ! Get the women ! Join today !
773# 861#
774# make_desktop_entry(<command>, [name], [icon], [type], [path]) 862# make_desktop_entry(<command>, [name], [icon], [type], [fields])
775# 863#
776# binary: what command does the app run with ? 864# binary: what command does the app run with ?
777# name: the name that will show up in the menu 865# name: the name that will show up in the menu
778# icon: give your little like a pretty little icon ... 866# icon: give your little like a pretty little icon ...
779# this can be relative (to /usr/share/pixmaps) or 867# this can be relative (to /usr/share/pixmaps) or
780# a full path to an icon 868# a full path to an icon
781# type: what kind of application is this ? for categories: 869# type: what kind of application is this ? for categories:
782# http://www.freedesktop.org/Standards/desktop-entry-spec 870# http://standards.freedesktop.org/menu-spec/latest/apa.html
783# path: if your app needs to startup in a specific dir 871# fields: extra fields to append to the desktop file; a printf string
784make_desktop_entry() { 872make_desktop_entry() {
785 [[ -z $1 ]] && eerror "make_desktop_entry: You must specify the executable" && return 1 873 [[ -z $1 ]] && die "make_desktop_entry: You must specify the executable"
786 874
787 local exec=${1} 875 local exec=${1}
788 local name=${2:-${PN}} 876 local name=${2:-${PN}}
789 local icon=${3:-${PN}.png} 877 local icon=${3:-${PN}}
790 local type=${4} 878 local type=${4}
791 local path=${5} 879 local fields=${5}
792 880
793 if [[ -z ${type} ]] ; then 881 if [[ -z ${type} ]] ; then
794 local catmaj=${CATEGORY%%-*} 882 local catmaj=${CATEGORY%%-*}
795 local catmin=${CATEGORY##*-} 883 local catmin=${CATEGORY##*-}
796 case ${catmaj} in 884 case ${catmaj} in
797 app) 885 app)
798 case ${catmin} in 886 case ${catmin} in
887 accessibility) type=Accessibility;;
799 admin) type=System;; 888 admin) type=System;;
889 antivirus) type=System;;
890 arch) type=Archiving;;
891 backup) type=Archiving;;
800 cdr) type=DiscBurning;; 892 cdr) type=DiscBurning;;
801 dicts) type=Dictionary;; 893 dicts) type=Dictionary;;
894 doc) type=Documentation;;
802 editors) type=TextEditor;; 895 editors) type=TextEditor;;
803 emacs) type=TextEditor;; 896 emacs) type=TextEditor;;
804 emulation) type=Emulator;; 897 emulation) type=Emulator;;
805 laptop) type=HardwareSettings;; 898 laptop) type=HardwareSettings;;
806 office) type=Office;; 899 office) type=Office;;
900 pda) type=PDA;;
807 vim) type=TextEditor;; 901 vim) type=TextEditor;;
808 xemacs) type=TextEditor;; 902 xemacs) type=TextEditor;;
809 *) type=;;
810 esac 903 esac
811 ;; 904 ;;
812 905
813 dev) 906 dev)
814 type="Development" 907 type="Development"
815 ;; 908 ;;
816 909
817 games) 910 games)
818 case ${catmin} in 911 case ${catmin} in
819 action|fps) type=ActionGame;; 912 action|fps) type=ActionGame;;
820 arcade) type=ArcadeGame;; 913 arcade) type=ArcadeGame;;
821 board) type=BoardGame;; 914 board) type=BoardGame;;
822 kids) type=KidsGame;;
823 emulation) type=Emulator;; 915 emulation) type=Emulator;;
916 kids) type=KidsGame;;
824 puzzle) type=LogicGame;; 917 puzzle) type=LogicGame;;
825 rpg) type=RolePlaying;;
826 roguelike) type=RolePlaying;; 918 roguelike) type=RolePlaying;;
919 rpg) type=RolePlaying;;
827 simulation) type=Simulation;; 920 simulation) type=Simulation;;
828 sports) type=SportsGame;; 921 sports) type=SportsGame;;
829 strategy) type=StrategyGame;; 922 strategy) type=StrategyGame;;
830 *) type=;;
831 esac 923 esac
832 type="Game;${type}" 924 type="Game;${type}"
833 ;; 925 ;;
834 926
927 gnome)
928 type="Gnome;GTK"
929 ;;
930
931 kde)
932 type="KDE;Qt"
933 ;;
934
835 mail) 935 mail)
836 type="Network;Email" 936 type="Network;Email"
837 ;; 937 ;;
838 938
839 media) 939 media)
840 case ${catmin} in 940 case ${catmin} in
941 gfx)
841 gfx) type=Graphics;; 942 type=Graphics
943 ;;
944 *)
945 case ${catmin} in
842 radio) type=Tuner;; 946 radio) type=Tuner;;
843 sound) type=Audio;; 947 sound) type=Audio;;
844 tv) type=TV;; 948 tv) type=TV;;
845 video) type=Video;; 949 video) type=Video;;
846 *) type=;; 950 esac
951 type="AudioVideo;${type}"
952 ;;
847 esac 953 esac
848 type="AudioVideo;${type}"
849 ;; 954 ;;
850 955
851 net) 956 net)
852 case ${catmin} in 957 case ${catmin} in
853 dialup) type=Dialup;; 958 dialup) type=Dialup;;
854 ftp) type=FileTransfer;; 959 ftp) type=FileTransfer;;
855 im) type=InstantMessaging;; 960 im) type=InstantMessaging;;
856 irc) type=IRCClient;; 961 irc) type=IRCClient;;
857 mail) type=Email;; 962 mail) type=Email;;
858 news) type=News;; 963 news) type=News;;
859 nntp) type=News;; 964 nntp) type=News;;
860 p2p) type=FileTransfer;; 965 p2p) type=FileTransfer;;
861 *) type=;; 966 voip) type=Telephony;;
862 esac 967 esac
863 type="Network;${type}" 968 type="Network;${type}"
864 ;; 969 ;;
865 970
866 sci) 971 sci)
867 case ${catmin} in 972 case ${catmin} in
868 astro*) type=Astronomy;; 973 astro*) type=Astronomy;;
869 bio*) type=Biology;; 974 bio*) type=Biology;;
870 calc*) type=Calculator;; 975 calc*) type=Calculator;;
871 chem*) type=Chemistry;; 976 chem*) type=Chemistry;;
977 elec*) type=Electronics;;
872 geo*) type=Geology;; 978 geo*) type=Geology;;
873 math*) type=Math;; 979 math*) type=Math;;
874 *) type=;; 980 physics) type=Physics;;
981 visual*) type=DataVisualization;;
875 esac 982 esac
876 type="Science;${type}" 983 type="Education;Science;${type}"
984 ;;
985
986 sys)
987 type="System"
877 ;; 988 ;;
878 989
879 www) 990 www)
880 case ${catmin} in 991 case ${catmin} in
881 client) type=WebBrowser;; 992 client) type=WebBrowser;;
882 *) type=;;
883 esac 993 esac
884 type="Network" 994 type="Network;${type}"
885 ;; 995 ;;
886 996
887 *) 997 *)
888 type= 998 type=
889 ;; 999 ;;
895 local desktop_name="${PN}-${SLOT}" 1005 local desktop_name="${PN}-${SLOT}"
896 fi 1006 fi
897 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop" 1007 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop"
898 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop 1008 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop
899 1009
1010 # Don't append another ";" when a valid category value is provided.
1011 type=${type%;}${type:+;}
1012
1013 eshopts_push -s extglob
1014 if [[ -n ${icon} && ${icon} != /* ]] && [[ ${icon} == *.xpm || ${icon} == *.png || ${icon} == *.svg ]]; then
1015 ewarn "As described in the Icon Theme Specification, icon file extensions are not"
1016 ewarn "allowed in .desktop files if the value is not an absolute path."
1017 icon=${icon%.@(xpm|png|svg)}
1018 fi
1019 eshopts_pop
1020
900 cat <<-EOF > "${desktop}" 1021 cat <<-EOF > "${desktop}"
901 [Desktop Entry] 1022 [Desktop Entry]
902 Encoding=UTF-8
903 Version=0.9.2
904 Name=${name} 1023 Name=${name}
905 Type=Application 1024 Type=Application
906 Comment=${DESCRIPTION} 1025 Comment=${DESCRIPTION}
907 Exec=${exec} 1026 Exec=${exec}
908 TryExec=${exec%% *} 1027 TryExec=${exec%% *}
909 Path=${path}
910 Icon=${icon} 1028 Icon=${icon}
911 Categories=Application;${type}; 1029 Categories=${type}
912 EOF 1030 EOF
1031
1032 if [[ ${fields:-=} != *=* ]] ; then
1033 # 5th arg used to be value to Path=
1034 ewarn "make_desktop_entry: update your 5th arg to read Path=${fields}"
1035 fields="Path=${fields}"
1036 fi
1037 [[ -n ${fields} ]] && printf '%b\n' "${fields}" >> "${desktop}"
913 1038
914 ( 1039 (
915 # wrap the env here so that the 'insinto' call 1040 # wrap the env here so that the 'insinto' call
916 # doesn't corrupt the env of the caller 1041 # doesn't corrupt the env of the caller
917 insinto /usr/share/applications 1042 insinto /usr/share/applications
918 doins "${desktop}" 1043 doins "${desktop}"
919 ) 1044 ) || die "installing desktop file failed"
920} 1045}
921 1046
922 1047# @FUNCTION: validate_desktop_entries
1048# @USAGE: [directories]
1049# @MAINTAINER:
1050# Carsten Lohrke <carlo@gentoo.org>
1051# @DESCRIPTION:
923# Validate desktop entries using desktop-file-utils 1052# Validate desktop entries using desktop-file-utils
924# Carsten Lohrke <carlo@gentoo.org>
925#
926# Usage: validate_desktop_entries [directory ...]
927
928validate_desktop_entries() { 1053validate_desktop_entries() {
929 if [[ -x /usr/bin/desktop-file-validate ]] ; then 1054 if [[ -x /usr/bin/desktop-file-validate ]] ; then
930 einfo "Checking desktop entry validity" 1055 einfo "Checking desktop entry validity"
931 local directories="" 1056 local directories=""
932 for d in /usr/share/applications $@ ; do 1057 for d in /usr/share/applications $@ ; do
945 else 1070 else
946 einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo." 1071 einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo."
947 fi 1072 fi
948} 1073}
949 1074
950 1075# @FUNCTION: make_session_desktop
951# Make a GDM/KDM Session file 1076# @USAGE: <title> <command> [command args...]
1077# @DESCRIPTION:
1078# Make a GDM/KDM Session file. The title is the file to execute to start the
1079# Window Manager. The command is the name of the Window Manager.
952# 1080#
953# make_session_desktop(<title>, <command>) 1081# You can set the name of the file via the ${wm} variable.
954# title: File to execute to start the Window Manager
955# command: Name of the Window Manager
956
957make_session_desktop() { 1082make_session_desktop() {
958 [[ -z $1 ]] && eerror "make_session_desktop: You must specify the title" && return 1 1083 [[ -z $1 ]] && eerror "$0: You must specify the title" && return 1
959 [[ -z $2 ]] && eerror "make_session_desktop: You must specify the command" && return 1 1084 [[ -z $2 ]] && eerror "$0: You must specify the command" && return 1
960 1085
961 local title=$1 1086 local title=$1
962 local command=$2 1087 local command=$2
963 local desktop=${T}/${wm}.desktop 1088 local desktop=${T}/${wm:-${PN}}.desktop
1089 shift 2
964 1090
965 cat <<-EOF > "${desktop}" 1091 cat <<-EOF > "${desktop}"
966 [Desktop Entry] 1092 [Desktop Entry]
967 Encoding=UTF-8
968 Name=${title} 1093 Name=${title}
969 Comment=This session logs you into ${title} 1094 Comment=This session logs you into ${title}
970 Exec=${command} 1095 Exec=${command} $*
971 TryExec=${command} 1096 TryExec=${command}
972 Type=Application 1097 Type=XSession
973 EOF 1098 EOF
974 1099
975 ( 1100 (
976 # wrap the env here so that the 'insinto' call 1101 # wrap the env here so that the 'insinto' call
977 # doesn't corrupt the env of the caller 1102 # doesn't corrupt the env of the caller
978 insinto /usr/share/xsessions 1103 insinto /usr/share/xsessions
979 doins "${desktop}" 1104 doins "${desktop}"
980 ) 1105 )
981} 1106}
982 1107
1108# @FUNCTION: domenu
1109# @USAGE: <menus>
1110# @DESCRIPTION:
1111# Install the list of .desktop menu files into the appropriate directory
1112# (/usr/share/applications).
983domenu() { 1113domenu() {
984 ( 1114 (
985 # wrap the env here so that the 'insinto' call 1115 # wrap the env here so that the 'insinto' call
986 # doesn't corrupt the env of the caller 1116 # doesn't corrupt the env of the caller
987 local i j ret=0 1117 local i j ret=0
993 elif [[ -d ${i} ]] ; then 1123 elif [[ -d ${i} ]] ; then
994 for j in "${i}"/*.desktop ; do 1124 for j in "${i}"/*.desktop ; do
995 doins "${j}" 1125 doins "${j}"
996 ((ret+=$?)) 1126 ((ret+=$?))
997 done 1127 done
1128 else
1129 ((++ret))
998 fi 1130 fi
999 done 1131 done
1000 exit ${ret} 1132 exit ${ret}
1001 ) 1133 )
1002} 1134}
1135
1136# @FUNCTION: newmenu
1137# @USAGE: <menu> <newname>
1138# @DESCRIPTION:
1139# Like all other new* functions, install the specified menu as newname.
1003newmenu() { 1140newmenu() {
1004 ( 1141 (
1005 # wrap the env here so that the 'insinto' call 1142 # wrap the env here so that the 'insinto' call
1006 # doesn't corrupt the env of the caller 1143 # doesn't corrupt the env of the caller
1007 insinto /usr/share/applications 1144 insinto /usr/share/applications
1008 newins "$@" 1145 newins "$@"
1009 ) 1146 )
1010} 1147}
1011 1148
1149# @FUNCTION: doicon
1150# @USAGE: <list of icons>
1151# @DESCRIPTION:
1152# Install the list of icons into the icon directory (/usr/share/pixmaps).
1153# This is useful in conjunction with creating desktop/menu files.
1012doicon() { 1154doicon() {
1013 ( 1155 (
1014 # wrap the env here so that the 'insinto' call 1156 # wrap the env here so that the 'insinto' call
1015 # doesn't corrupt the env of the caller 1157 # doesn't corrupt the env of the caller
1016 local i j ret 1158 local i j ret
1022 elif [[ -d ${i} ]] ; then 1164 elif [[ -d ${i} ]] ; then
1023 for j in "${i}"/*.png ; do 1165 for j in "${i}"/*.png ; do
1024 doins "${j}" 1166 doins "${j}"
1025 ((ret+=$?)) 1167 ((ret+=$?))
1026 done 1168 done
1169 else
1170 ((++ret))
1027 fi 1171 fi
1028 done 1172 done
1029 exit ${ret} 1173 exit ${ret}
1030 ) 1174 )
1031} 1175}
1176
1177# @FUNCTION: newicon
1178# @USAGE: <icon> <newname>
1179# @DESCRIPTION:
1180# Like all other new* functions, install the specified icon as newname.
1032newicon() { 1181newicon() {
1033 ( 1182 (
1034 # wrap the env here so that the 'insinto' call 1183 # wrap the env here so that the 'insinto' call
1035 # doesn't corrupt the env of the caller 1184 # doesn't corrupt the env of the caller
1036 insinto /usr/share/pixmaps 1185 insinto /usr/share/pixmaps
1037 newins "$@" 1186 newins "$@"
1038 ) 1187 )
1039} 1188}
1040
1041##############################################################
1042# END: Handle .desktop files and menu entries #
1043##############################################################
1044
1045 1189
1046# for internal use only (unpack_pdv and unpack_makeself) 1190# for internal use only (unpack_pdv and unpack_makeself)
1047find_unpackable_file() { 1191find_unpackable_file() {
1048 local src=$1 1192 local src=$1
1049 if [[ -z ${src} ]] ; then 1193 if [[ -z ${src} ]] ; then
1059 fi 1203 fi
1060 [[ ! -e ${src} ]] && return 1 1204 [[ ! -e ${src} ]] && return 1
1061 echo "${src}" 1205 echo "${src}"
1062} 1206}
1063 1207
1208# @FUNCTION: unpack_pdv
1209# @USAGE: <file to unpack> <size of off_t>
1210# @DESCRIPTION:
1064# Unpack those pesky pdv generated files ... 1211# Unpack those pesky pdv generated files ...
1065# They're self-unpacking programs with the binary package stuffed in 1212# They're self-unpacking programs with the binary package stuffed in
1066# the middle of the archive. Valve seems to use it a lot ... too bad 1213# the middle of the archive. Valve seems to use it a lot ... too bad
1067# it seems to like to segfault a lot :(. So lets take it apart ourselves. 1214# it seems to like to segfault a lot :(. So lets take it apart ourselves.
1068# 1215#
1069# Usage: unpack_pdv [file to unpack] [size of off_t]
1070# - you have to specify the off_t size ... i have no idea how to extract that 1216# You have to specify the off_t size ... I have no idea how to extract that
1071# information out of the binary executable myself. basically you pass in 1217# information out of the binary executable myself. Basically you pass in
1072# the size of the off_t type (in bytes) on the machine that built the pdv 1218# the size of the off_t type (in bytes) on the machine that built the pdv
1219# archive.
1220#
1073# archive. one way to determine this is by running the following commands: 1221# One way to determine this is by running the following commands:
1222#
1223# @CODE
1074# strings <pdv archive> | grep lseek 1224# strings <pdv archive> | grep lseek
1075# strace -elseek <pdv archive> 1225# strace -elseek <pdv archive>
1226# @CODE
1227#
1076# basically look for the first lseek command (we do the strings/grep because 1228# Basically look for the first lseek command (we do the strings/grep because
1077# sometimes the function call is _llseek or something) and steal the 2nd 1229# sometimes the function call is _llseek or something) and steal the 2nd
1078# parameter. here is an example: 1230# parameter. Here is an example:
1231#
1232# @CODE
1079# root@vapier 0 pdv_unpack # strings hldsupdatetool.bin | grep lseek 1233# vapier@vapier 0 pdv_unpack # strings hldsupdatetool.bin | grep lseek
1080# lseek 1234# lseek
1081# root@vapier 0 pdv_unpack # strace -elseek ./hldsupdatetool.bin 1235# vapier@vapier 0 pdv_unpack # strace -elseek ./hldsupdatetool.bin
1082# lseek(3, -4, SEEK_END) = 2981250 1236# lseek(3, -4, SEEK_END) = 2981250
1237# @CODE
1238#
1083# thus we would pass in the value of '4' as the second parameter. 1239# Thus we would pass in the value of '4' as the second parameter.
1084unpack_pdv() { 1240unpack_pdv() {
1085 local src=$(find_unpackable_file "$1") 1241 local src=$(find_unpackable_file "$1")
1086 local sizeoff_t=$2 1242 local sizeoff_t=$2
1087 1243
1088 [[ -z ${src} ]] && die "Could not locate source for '$1'" 1244 [[ -z ${src} ]] && die "Could not locate source for '$1'"
1150 true 1306 true
1151 #[ -s "${datafile}" ] || die "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')" 1307 #[ -s "${datafile}" ] || die "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
1152 #assert "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')" 1308 #assert "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
1153} 1309}
1154 1310
1311# @FUNCTION: unpack_makeself
1312# @USAGE: [file to unpack] [offset] [tail|dd]
1313# @DESCRIPTION:
1155# Unpack those pesky makeself generated files ... 1314# Unpack those pesky makeself generated files ...
1156# They're shell scripts with the binary package tagged onto 1315# They're shell scripts with the binary package tagged onto
1157# the end of the archive. Loki utilized the format as does 1316# the end of the archive. Loki utilized the format as does
1158# many other game companies. 1317# many other game companies.
1159# 1318#
1160# Usage: unpack_makeself [file to unpack] [offset] [tail|dd] 1319# If the file is not specified, then ${A} is used. If the
1161# - If the file is not specified then unpack will utilize ${A}.
1162# - If the offset is not specified then we will attempt to extract 1320# offset is not specified then we will attempt to extract
1163# the proper offset from the script itself. 1321# the proper offset from the script itself.
1164unpack_makeself() { 1322unpack_makeself() {
1165 local src_input=${1:-${A}} 1323 local src_input=${1:-${A}}
1166 local src=$(find_unpackable_file "${src_input}") 1324 local src=$(find_unpackable_file "${src_input}")
1167 local skip=$2 1325 local skip=$2
1168 local exe=$3 1326 local exe=$3
1170 [[ -z ${src} ]] && die "Could not locate source for '${src_input}'" 1328 [[ -z ${src} ]] && die "Could not locate source for '${src_input}'"
1171 1329
1172 local shrtsrc=$(basename "${src}") 1330 local shrtsrc=$(basename "${src}")
1173 echo ">>> Unpacking ${shrtsrc} to ${PWD}" 1331 echo ">>> Unpacking ${shrtsrc} to ${PWD}"
1174 if [[ -z ${skip} ]] ; then 1332 if [[ -z ${skip} ]] ; then
1175 local ver=$(grep -a '#.*Makeself' "${src}" | awk '{print $NF}') 1333 local ver=$(grep -m1 -a '#.*Makeself' "${src}" | awk '{print $NF}')
1176 local skip=0 1334 local skip=0
1177 exe=tail 1335 exe=tail
1178 case ${ver} in 1336 case ${ver} in
1179 1.5.*|1.6.0-nv) # tested 1.5.{3,4,5} ... guessing 1.5.x series is same 1337 1.5.*|1.6.0-nv) # tested 1.5.{3,4,5} ... guessing 1.5.x series is same
1180 skip=$(grep -a ^skip= "${src}" | cut -d= -f2) 1338 skip=$(grep -a ^skip= "${src}" | cut -d= -f2)
1182 2.0|2.0.1) 1340 2.0|2.0.1)
1183 skip=$(grep -a ^$'\t'tail "${src}" | awk '{print $2}' | cut -b2-) 1341 skip=$(grep -a ^$'\t'tail "${src}" | awk '{print $2}' | cut -b2-)
1184 ;; 1342 ;;
1185 2.1.1) 1343 2.1.1)
1186 skip=$(grep -a ^offset= "${src}" | awk '{print $2}' | cut -b2-) 1344 skip=$(grep -a ^offset= "${src}" | awk '{print $2}' | cut -b2-)
1187 let skip="skip + 1" 1345 (( skip++ ))
1188 ;; 1346 ;;
1189 2.1.2) 1347 2.1.2)
1190 skip=$(grep -a ^offset= "${src}" | awk '{print $3}' | head -n 1) 1348 skip=$(grep -a ^offset= "${src}" | awk '{print $3}' | head -n 1)
1191 let skip="skip + 1" 1349 (( skip++ ))
1192 ;; 1350 ;;
1193 2.1.3) 1351 2.1.3)
1194 skip=`grep -a ^offset= "${src}" | awk '{print $3}'` 1352 skip=`grep -a ^offset= "${src}" | awk '{print $3}'`
1195 let skip="skip + 1" 1353 (( skip++ ))
1196 ;; 1354 ;;
1197 2.1.4|2.1.5) 1355 2.1.4|2.1.5)
1198 skip=$(grep -a offset=.*head.*wc "${src}" | awk '{print $3}' | head -n 1) 1356 skip=$(grep -a offset=.*head.*wc "${src}" | awk '{print $3}' | head -n 1)
1199 skip=$(head -n ${skip} "${src}" | wc -c) 1357 skip=$(head -n ${skip} "${src}" | wc -c)
1200 exe="dd" 1358 exe="dd"
1209 esac 1367 esac
1210 debug-print "Detected Makeself version ${ver} ... using ${skip} as offset" 1368 debug-print "Detected Makeself version ${ver} ... using ${skip} as offset"
1211 fi 1369 fi
1212 case ${exe} in 1370 case ${exe} in
1213 tail) exe="tail -n +${skip} '${src}'";; 1371 tail) exe="tail -n +${skip} '${src}'";;
1214 dd) exe="dd ibs=${skip} skip=1 obs=1024 conv=sync if='${src}'";; 1372 dd) exe="dd ibs=${skip} skip=1 if='${src}'";;
1215 *) die "makeself cant handle exe '${exe}'" 1373 *) die "makeself cant handle exe '${exe}'"
1216 esac 1374 esac
1217 1375
1218 # lets grab the first few bytes of the file to figure out what kind of archive it is 1376 # lets grab the first few bytes of the file to figure out what kind of archive it is
1219 local tmpfile=$(emktemp) 1377 local tmpfile=$(emktemp)
1238 ;; 1396 ;;
1239 esac 1397 esac
1240 assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})" 1398 assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})"
1241} 1399}
1242 1400
1401# @FUNCTION: check_license
1402# @USAGE: [license]
1403# @DESCRIPTION:
1243# Display a license for user to accept. 1404# Display a license for user to accept. If no license is
1244#
1245# Usage: check_license [license]
1246# - If the file is not specified then ${LICENSE} is used. 1405# specified, then ${LICENSE} is used.
1247check_license() { 1406check_license() {
1248 local lic=$1 1407 local lic=$1
1249 if [ -z "${lic}" ] ; then 1408 if [ -z "${lic}" ] ; then
1250 lic="${PORTDIR}/licenses/${LICENSE}" 1409 lic="${PORTDIR}/licenses/${LICENSE}"
1251 else 1410 else
1255 lic="${PWD}/${lic}" 1414 lic="${PWD}/${lic}"
1256 elif [ -e "${lic}" ] ; then 1415 elif [ -e "${lic}" ] ; then
1257 lic="${lic}" 1416 lic="${lic}"
1258 fi 1417 fi
1259 fi 1418 fi
1260 [ ! -f "${lic}" ] && die "Could not find requested license ${lic}"
1261 local l="`basename ${lic}`" 1419 local l="`basename ${lic}`"
1262 1420
1263 # here is where we check for the licenses the user already 1421 # here is where we check for the licenses the user already
1264 # accepted ... if we don't find a match, we make the user accept 1422 # accepted ... if we don't find a match, we make the user accept
1265 local shopts=$-
1266 local alic 1423 local alic
1267 set -o noglob #so that bash doesn't expand "*" 1424 eshopts_push -o noglob # so that bash doesn't expand "*"
1268 for alic in ${ACCEPT_LICENSE} ; do 1425 for alic in ${ACCEPT_LICENSE} ; do
1269 if [[ ${alic} == ${l} ]]; then 1426 if [[ ${alic} == ${l} ]]; then
1270 set +o noglob; set -${shopts} #reset old shell opts 1427 eshopts_pop
1271 return 0 1428 return 0
1272 fi 1429 fi
1273 done 1430 done
1274 set +o noglob; set -$shopts #reset old shell opts 1431 eshopts_pop
1432 [ ! -f "${lic}" ] && die "Could not find requested license ${lic}"
1275 1433
1276 local licmsg=$(emktemp) 1434 local licmsg=$(emktemp)
1277 cat <<-EOF > ${licmsg} 1435 cat <<-EOF > ${licmsg}
1278 ********************************************************** 1436 **********************************************************
1279 The following license outlines the terms of use of this 1437 The following license outlines the terms of use of this
1280 package. You MUST accept this license for installation to 1438 package. You MUST accept this license for installation to
1281 continue. When you are done viewing, hit 'q'. If you 1439 continue. When you are done viewing, hit 'q'. If you
1282 CTRL+C out of this, the install will not run! 1440 CTRL+C out of this, the install will not run!
1283 ********************************************************** 1441 **********************************************************
1284 1442
1285 EOF 1443 EOF
1286 cat ${lic} >> ${licmsg} 1444 cat ${lic} >> ${licmsg}
1287 ${PAGER:-less} ${licmsg} || die "Could not execute pager (${PAGER}) to accept ${lic}" 1445 ${PAGER:-less} ${licmsg} || die "Could not execute pager (${PAGER}) to accept ${lic}"
1288 einfon "Do you accept the terms of this license (${l})? [yes/no] " 1446 einfon "Do you accept the terms of this license (${l})? [yes/no] "
1289 read alic 1447 read alic
1297 die "Failed to accept license" 1455 die "Failed to accept license"
1298 ;; 1456 ;;
1299 esac 1457 esac
1300} 1458}
1301 1459
1460# @FUNCTION: cdrom_get_cds
1461# @USAGE: <file on cd1> [file on cd2] [file on cd3] [...]
1462# @DESCRIPTION:
1302# Aquire cd(s) for those lovely cd-based emerges. Yes, this violates 1463# Aquire cd(s) for those lovely cd-based emerges. Yes, this violates
1303# the whole 'non-interactive' policy, but damnit I want CD support ! 1464# the whole 'non-interactive' policy, but damnit I want CD support !
1304# 1465#
1305# with these cdrom functions we handle all the user interaction and 1466# With these cdrom functions we handle all the user interaction and
1306# standardize everything. all you have to do is call cdrom_get_cds() 1467# standardize everything. All you have to do is call cdrom_get_cds()
1307# and when the function returns, you can assume that the cd has been 1468# and when the function returns, you can assume that the cd has been
1308# found at CDROM_ROOT. 1469# found at CDROM_ROOT.
1309# 1470#
1471# The function will attempt to locate a cd based upon a file that is on
1472# the cd. The more files you give this function, the more cds
1473# the cdrom functions will handle.
1474#
1310# normally the cdrom functions will refer to the cds as 'cd #1', 'cd #2', 1475# Normally the cdrom functions will refer to the cds as 'cd #1', 'cd #2',
1311# etc... if you want to give the cds better names, then just export 1476# etc... If you want to give the cds better names, then just export
1312# the appropriate CDROM_NAME variable before calling cdrom_get_cds(). 1477# the appropriate CDROM_NAME variable before calling cdrom_get_cds().
1313# - CDROM_NAME="fooie cd" - for when you only want 1 cd 1478# Use CDROM_NAME for one cd, or CDROM_NAME_# for multiple cds. You can
1314# - CDROM_NAME_1="install cd" - for when you want more than 1 cd 1479# also use the CDROM_NAME_SET bash array.
1315# CDROM_NAME_2="data cd"
1316# - CDROM_NAME_SET=( "install cd" "data cd" ) - short hand for CDROM_NAME_#
1317# 1480#
1318# for those multi cd ebuilds, see the cdrom_load_next_cd() below. 1481# For those multi cd ebuilds, see the cdrom_load_next_cd() function.
1319#
1320# Usage: cdrom_get_cds <file on cd1> [file on cd2] [file on cd3] [...]
1321# - this will attempt to locate a cd based upon a file that is on
1322# the cd ... the more files you give this function, the more cds
1323# the cdrom functions will handle
1324cdrom_get_cds() { 1482cdrom_get_cds() {
1325 # first we figure out how many cds we're dealing with by 1483 # first we figure out how many cds we're dealing with by
1326 # the # of files they gave us 1484 # the # of files they gave us
1327 local cdcnt=0 1485 local cdcnt=0
1328 local f= 1486 local f=
1414 export CDROM_SET="" 1572 export CDROM_SET=""
1415 export CDROM_CURRENT_CD=0 1573 export CDROM_CURRENT_CD=0
1416 cdrom_load_next_cd 1574 cdrom_load_next_cd
1417} 1575}
1418 1576
1419# this is only used when you need access to more than one cd. 1577# @FUNCTION: cdrom_load_next_cd
1420# when you have finished using the first cd, just call this function. 1578# @DESCRIPTION:
1421# when it returns, CDROM_ROOT will be pointing to the second cd. 1579# Some packages are so big they come on multiple CDs. When you're done reading
1422# remember, you can only go forward in the cd chain, you can't go back. 1580# files off a CD and want access to the next one, just call this function.
1581# Again, all the messy details of user interaction are taken care of for you.
1582# Once this returns, just read the variable CDROM_ROOT for the location of the
1583# mounted CD. Note that you can only go forward in the CD list, so make sure
1584# you only call this function when you're done using the current CD.
1423cdrom_load_next_cd() { 1585cdrom_load_next_cd() {
1424 local var 1586 local var
1425 ((++CDROM_CURRENT_CD)) 1587 ((++CDROM_CURRENT_CD))
1426 1588
1427 unset CDROM_ROOT 1589 unset CDROM_ROOT
1444# displayed and we'll hang out here until: 1606# displayed and we'll hang out here until:
1445# (1) the file is found on a mounted cdrom 1607# (1) the file is found on a mounted cdrom
1446# (2) the user hits CTRL+C 1608# (2) the user hits CTRL+C
1447_cdrom_locate_file_on_cd() { 1609_cdrom_locate_file_on_cd() {
1448 local mline="" 1610 local mline=""
1449 local showedmsg=0 1611 local showedmsg=0 showjolietmsg=0
1450 1612
1451 while [[ -z ${CDROM_ROOT} ]] ; do 1613 while [[ -z ${CDROM_ROOT} ]] ; do
1452 local i=0 1614 local i=0
1453 local -a cdset=(${*//:/ }) 1615 local -a cdset=(${*//:/ })
1454 if [[ -n ${CDROM_SET} ]] ; then 1616 if [[ -n ${CDROM_SET} ]] ; then
1459 local dir=$(dirname ${cdset[${i}]}) 1621 local dir=$(dirname ${cdset[${i}]})
1460 local file=$(basename ${cdset[${i}]}) 1622 local file=$(basename ${cdset[${i}]})
1461 1623
1462 local point= node= fs= foo= 1624 local point= node= fs= foo=
1463 while read point node fs foo ; do 1625 while read point node fs foo ; do
1464 [[ " cd9660 iso9660 " != *" ${fs} "* ]] && \ 1626 [[ " cd9660 iso9660 udf " != *" ${fs} "* ]] && \
1465 ! [[ ${fs} == "subfs" && ",${opts}," == *",fs=cdfss,"* ]] \ 1627 ! [[ ${fs} == "subfs" && ",${opts}," == *",fs=cdfss,"* ]] \
1466 && continue 1628 && continue
1467 point=${point//\040/ } 1629 point=${point//\040/ }
1630 [[ ! -d ${point}/${dir} ]] && continue
1468 [[ -z $(find "${point}/${dir}" -maxdepth 1 -iname "${file}") ]] && continue 1631 [[ -z $(find "${point}/${dir}" -maxdepth 1 -iname "${file}") ]] && continue
1469 export CDROM_ROOT=${point} 1632 export CDROM_ROOT=${point}
1470 export CDROM_SET=${i} 1633 export CDROM_SET=${i}
1471 export CDROM_MATCH=${cdset[${i}]} 1634 export CDROM_MATCH=${cdset[${i}]}
1472 return 1635 return
1494 showedmsg=1 1657 showedmsg=1
1495 fi 1658 fi
1496 einfo "Press return to scan for the cd again" 1659 einfo "Press return to scan for the cd again"
1497 einfo "or hit CTRL+C to abort the emerge." 1660 einfo "or hit CTRL+C to abort the emerge."
1498 echo 1661 echo
1662 if [[ ${showjolietmsg} -eq 0 ]] ; then
1663 showjolietmsg=1
1664 else
1499 einfo "If you are having trouble with the detection" 1665 ewarn "If you are having trouble with the detection"
1500 einfo "of your CD, it is possible that you do not have" 1666 ewarn "of your CD, it is possible that you do not have"
1501 einfo "Joliet support enabled in your kernel. Please" 1667 ewarn "Joliet support enabled in your kernel. Please"
1502 einfo "check that CONFIG_JOLIET is enabled in your kernel." 1668 ewarn "check that CONFIG_JOLIET is enabled in your kernel."
1669 ebeep 5
1670 fi
1503 read || die "something is screwed with your system" 1671 read || die "something is screwed with your system"
1504 done 1672 done
1505} 1673}
1506 1674
1675# @FUNCTION: strip-linguas
1676# @USAGE: [<allow LINGUAS>|<-i|-u> <directories of .po files>]
1677# @DESCRIPTION:
1507# Make sure that LINGUAS only contains languages that 1678# Make sure that LINGUAS only contains languages that
1508# a package can support 1679# a package can support. The first form allows you to
1509# 1680# specify a list of LINGUAS. The -i builds a list of po
1510# usage: strip-linguas <allow LINGUAS> 1681# files found in all the directories and uses the
1511# strip-linguas -i <directories of .po files> 1682# intersection of the lists. The -u builds a list of po
1512# strip-linguas -u <directories of .po files> 1683# files found in all the directories and uses the union
1513# 1684# of the lists.
1514# The first form allows you to specify a list of LINGUAS.
1515# The -i builds a list of po files found in all the
1516# directories and uses the intersection of the lists.
1517# The -u builds a list of po files found in all the
1518# directories and uses the union of the lists.
1519strip-linguas() { 1685strip-linguas() {
1520 local ls newls nols 1686 local ls newls nols
1521 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then 1687 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then
1522 local op=$1; shift 1688 local op=$1; shift
1523 ls=$(find "$1" -name '*.po' -exec basename {} .po \;); shift 1689 ls=$(find "$1" -name '*.po' -exec basename {} .po ';'); shift
1524 local d f 1690 local d f
1525 for d in "$@" ; do 1691 for d in "$@" ; do
1526 if [[ ${op} == "-u" ]] ; then 1692 if [[ ${op} == "-u" ]] ; then
1527 newls=${ls} 1693 newls=${ls}
1528 else 1694 else
1529 newls="" 1695 newls=""
1530 fi 1696 fi
1531 for f in $(find "$d" -name '*.po' -exec basename {} .po \;) ; do 1697 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do
1532 if [[ ${op} == "-i" ]] ; then 1698 if [[ ${op} == "-i" ]] ; then
1533 hasq ${f} ${ls} && newls="${newls} ${f}" 1699 hasq ${f} ${ls} && newls="${newls} ${f}"
1534 else 1700 else
1535 hasq ${f} ${ls} || newls="${newls} ${f}" 1701 hasq ${f} ${ls} || newls="${newls} ${f}"
1536 fi 1702 fi
1549 else 1715 else
1550 nols="${nols} ${f}" 1716 nols="${nols} ${f}"
1551 fi 1717 fi
1552 done 1718 done
1553 [[ -n ${nols} ]] \ 1719 [[ -n ${nols} ]] \
1554 && ewarn "Sorry, but ${PN} does not support the LINGUAs:" ${nols} 1720 && ewarn "Sorry, but ${PN} does not support the LINGUAS:" ${nols}
1555 export LINGUAS=${newls:1} 1721 export LINGUAS=${newls:1}
1556} 1722}
1557 1723
1558# moved from kernel.eclass since they are generally useful outside of 1724# @FUNCTION: preserve_old_lib
1559# kernel.eclass -iggy (20041002) 1725# @USAGE: <libs to preserve> [more libs]
1560 1726# @DESCRIPTION:
1561# the following functions are useful in kernel module ebuilds, etc.
1562# for an example see ivtv or drbd ebuilds
1563
1564# set's ARCH to match what the kernel expects
1565set_arch_to_kernel() {
1566 i=10
1567 while ((i--)) ; do
1568 ewarn "PLEASE UPDATE TO YOUR PACKAGE TO USE linux-info.eclass"
1569 done
1570 export EUTILS_ECLASS_PORTAGE_ARCH="${ARCH}"
1571 case ${ARCH} in
1572 x86) export ARCH="i386";;
1573 amd64) export ARCH="x86_64";;
1574 hppa) export ARCH="parisc";;
1575 mips) export ARCH="mips";;
1576 sparc) export ARCH="$(tc-arch-kernel)";; # Yeah this is ugly, but it's even WORSE if you don't do this. linux-info.eclass's set_arch_to_kernel is fixed, but won't get used over this one!
1577 *) export ARCH="${ARCH}";;
1578 esac
1579}
1580
1581# set's ARCH back to what portage expects
1582set_arch_to_portage() {
1583 i=10
1584 while ((i--)) ; do
1585 ewarn "PLEASE UPDATE TO YOUR PACKAGE TO USE linux-info.eclass"
1586 done
1587 export ARCH="${EUTILS_ECLASS_PORTAGE_ARCH}"
1588}
1589
1590# Jeremy Huddleston <eradicator@gentoo.org>:
1591# preserve_old_lib /path/to/libblah.so.0
1592# preserve_old_lib_notify /path/to/libblah.so.0
1593#
1594# These functions are useful when a lib in your package changes --library. Such 1727# These functions are useful when a lib in your package changes ABI SONAME.
1595# an example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0 1728# An example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0
1596# would break packages that link against it. Most people get around this 1729# would break packages that link against it. Most people get around this
1597# by using the portage SLOT mechanism, but that is not always a relevant 1730# by using the portage SLOT mechanism, but that is not always a relevant
1598# solution, so instead you can add the following to your ebuilds: 1731# solution, so instead you can call this from pkg_preinst. See also the
1599# 1732# preserve_old_lib_notify function.
1600# pkg_preinst() {
1601# ...
1602# preserve_old_lib /usr/$(get_libdir)/libogg.so.0
1603# ...
1604# }
1605#
1606# pkg_postinst() {
1607# ...
1608# preserve_old_lib_notify /usr/$(get_libdir)/libogg.so.0
1609# ...
1610# }
1611
1612preserve_old_lib() { 1733preserve_old_lib() {
1613 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then 1734 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then
1614 eerror "preserve_old_lib() must be called from pkg_preinst() only" 1735 eerror "preserve_old_lib() must be called from pkg_preinst() only"
1615 die "Invalid preserve_old_lib() usage" 1736 die "Invalid preserve_old_lib() usage"
1616 fi 1737 fi
1617 [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]" 1738 [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]"
1739
1740 # let portage worry about it
1741 has preserve-libs ${FEATURES} && return 0
1618 1742
1619 local lib dir 1743 local lib dir
1620 for lib in "$@" ; do 1744 for lib in "$@" ; do
1621 [[ -e ${ROOT}/${lib} ]] || continue 1745 [[ -e ${ROOT}/${lib} ]] || continue
1622 dir=${lib%/*} 1746 dir=${lib%/*}
1624 cp "${ROOT}"/${lib} "${D}"/${lib} || die "cp ${lib} failed" 1748 cp "${ROOT}"/${lib} "${D}"/${lib} || die "cp ${lib} failed"
1625 touch "${D}"/${lib} 1749 touch "${D}"/${lib}
1626 done 1750 done
1627} 1751}
1628 1752
1753# @FUNCTION: preserve_old_lib_notify
1754# @USAGE: <libs to notify> [more libs]
1755# @DESCRIPTION:
1756# Spit helpful messages about the libraries preserved by preserve_old_lib.
1629preserve_old_lib_notify() { 1757preserve_old_lib_notify() {
1630 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then 1758 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then
1631 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only" 1759 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only"
1632 die "Invalid preserve_old_lib_notify() usage" 1760 die "Invalid preserve_old_lib_notify() usage"
1633 fi 1761 fi
1762
1763 # let portage worry about it
1764 has preserve-libs ${FEATURES} && return 0
1634 1765
1635 local lib notice=0 1766 local lib notice=0
1636 for lib in "$@" ; do 1767 for lib in "$@" ; do
1637 [[ -e ${ROOT}/${lib} ]] || continue 1768 [[ -e ${ROOT}/${lib} ]] || continue
1638 if [[ ${notice} -eq 0 ]] ; then 1769 if [[ ${notice} -eq 0 ]] ; then
1644 ewarn "helper program, simply emerge the 'gentoolkit' package." 1775 ewarn "helper program, simply emerge the 'gentoolkit' package."
1645 ewarn 1776 ewarn
1646 fi 1777 fi
1647 ewarn " # revdep-rebuild --library ${lib##*/}" 1778 ewarn " # revdep-rebuild --library ${lib##*/}"
1648 done 1779 done
1780 if [[ ${notice} -eq 1 ]] ; then
1781 ewarn
1782 ewarn "Once you've finished running revdep-rebuild, it should be safe to"
1783 ewarn "delete the old libraries. Here is a copy & paste for the lazy:"
1784 for lib in "$@" ; do
1785 ewarn " # rm '${lib}'"
1786 done
1787 fi
1649} 1788}
1650 1789
1651# Hack for people to figure out if a package was built with 1790# @FUNCTION: built_with_use
1652# certain USE flags
1653#
1654# Usage: built_with_use [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags> 1791# @USAGE: [--hidden] [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags>
1655# ex: built_with_use xchat gtk2 1792# @DESCRIPTION:
1656# 1793#
1657# Flags: -a all USE flags should be utilized 1794# Deprecated: Use EAPI 2 use deps in DEPEND|RDEPEND and with has_version calls.
1658# -o at least one USE flag should be utilized 1795#
1659# --missing peform the specified action if the flag is not in IUSE (true/false/die) 1796# A temporary hack until portage properly supports DEPENDing on USE
1660# --hidden USE flag we're checking is hidden expanded so it isnt in IUSE 1797# flags being enabled in packages. This will check to see if the specified
1661# Note: the default flag is '-a' 1798# DEPEND atom was built with the specified list of USE flags. The
1799# --missing option controls the behavior if called on a package that does
1800# not actually support the defined USE flags (aka listed in IUSE).
1801# The default is to abort (call die). The -a and -o flags control
1802# the requirements of the USE flags. They correspond to "and" and "or"
1803# logic. So the -a flag means all listed USE flags must be enabled
1804# while the -o flag means at least one of the listed IUSE flags must be
1805# enabled. The --hidden option is really for internal use only as it
1806# means the USE flag we're checking is hidden expanded, so it won't be found
1807# in IUSE like normal USE flags.
1808#
1809# Remember that this function isn't terribly intelligent so order of optional
1810# flags matter.
1662built_with_use() { 1811built_with_use() {
1663 local hidden="no" 1812 local hidden="no"
1664 if [[ $1 == "--hidden" ]] ; then 1813 if [[ $1 == "--hidden" ]] ; then
1665 hidden="yes" 1814 hidden="yes"
1666 shift 1815 shift
1695 die) die "Unable to determine what USE flags $PKG was built with";; 1844 die) die "Unable to determine what USE flags $PKG was built with";;
1696 esac 1845 esac
1697 fi 1846 fi
1698 1847
1699 if [[ ${hidden} == "no" ]] ; then 1848 if [[ ${hidden} == "no" ]] ; then
1700 local IUSE_BUILT=$(<${IUSEFILE}) 1849 local IUSE_BUILT=( $(<"${IUSEFILE}") )
1701 # Don't check USE_EXPAND #147237 1850 # Don't check USE_EXPAND #147237
1702 local expand 1851 local expand
1703 for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do 1852 for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do
1704 if [[ $1 == ${expand}_* ]] ; then 1853 if [[ $1 == ${expand}_* ]] ; then
1705 expand="" 1854 expand=""
1706 break 1855 break
1707 fi 1856 fi
1708 done 1857 done
1709 if [[ -n ${expand} ]] ; then 1858 if [[ -n ${expand} ]] ; then
1710 if ! has $1 ${IUSE_BUILT} ; then 1859 if ! has $1 ${IUSE_BUILT[@]#[-+]} ; then
1711 case ${missing_action} in 1860 case ${missing_action} in
1712 true) return 0;; 1861 true) return 0;;
1713 false) return 1;; 1862 false) return 1;;
1714 die) die "$PKG does not actually support the $1 USE flag!";; 1863 die) die "$PKG does not actually support the $1 USE flag!";;
1715 esac 1864 esac
1727 shift 1876 shift
1728 done 1877 done
1729 [[ ${opt} = "-a" ]] 1878 [[ ${opt} = "-a" ]]
1730} 1879}
1731 1880
1881# @FUNCTION: epunt_cxx
1882# @USAGE: [dir to scan]
1883# @DESCRIPTION:
1732# Many configure scripts wrongly bail when a C++ compiler 1884# Many configure scripts wrongly bail when a C++ compiler could not be
1733# could not be detected. #73450 1885# detected. If dir is not specified, then it defaults to ${S}.
1886#
1887# http://bugs.gentoo.org/73450
1734epunt_cxx() { 1888epunt_cxx() {
1735 local dir=$1 1889 local dir=$1
1736 [[ -z ${dir} ]] && dir=${S} 1890 [[ -z ${dir} ]] && dir=${S}
1737 ebegin "Removing useless C++ checks" 1891 ebegin "Removing useless C++ checks"
1738 local f 1892 local f
1739 for f in $(find ${dir} -name configure) ; do 1893 find "${dir}" -name configure | while read f ; do
1740 patch -p0 "${f}" "${PORTDIR}/eclass/ELT-patches/nocxx/nocxx.patch" > /dev/null 1894 patch --no-backup-if-mismatch -p0 "${f}" "${PORTDIR}/eclass/ELT-patches/nocxx/nocxx.patch" > /dev/null
1741 done 1895 done
1742 eend 0 1896 eend 0
1743} 1897}
1744 1898
1745# make a wrapper script ... 1899# @FUNCTION: make_wrapper
1746# NOTE: this was originally games_make_wrapper, but I noticed other places where 1900# @USAGE: <wrapper> <target> [chdir] [libpaths] [installpath]
1747# this could be used, so I have moved it here and made it not games-specific 1901# @DESCRIPTION:
1748# -- wolf31o2 1902# Create a shell wrapper script named wrapper in installpath
1749# $1 == wrapper name 1903# (defaults to the bindir) to execute target (default of wrapper) by
1750# $2 == binary to run 1904# first optionally setting LD_LIBRARY_PATH to the colon-delimited
1751# $3 == directory to chdir before running binary 1905# libpaths followed by optionally changing directory to chdir.
1752# $4 == extra LD_LIBRARY_PATH's (make it : delimited)
1753# $5 == path for wrapper
1754make_wrapper() { 1906make_wrapper() {
1755 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5 1907 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5
1756 local tmpwrapper=$(emktemp) 1908 local tmpwrapper=$(emktemp)
1757 # We don't want to quote ${bin} so that people can pass complex 1909 # We don't want to quote ${bin} so that people can pass complex
1758 # things as $bin ... "./someprog --args" 1910 # things as $bin ... "./someprog --args"
1768fi 1920fi
1769exec ${bin} "\$@" 1921exec ${bin} "\$@"
1770EOF 1922EOF
1771 chmod go+rx "${tmpwrapper}" 1923 chmod go+rx "${tmpwrapper}"
1772 if [[ -n ${path} ]] ; then 1924 if [[ -n ${path} ]] ; then
1925 (
1773 exeinto "${path}" 1926 exeinto "${path}"
1774 newexe "${tmpwrapper}" "${wrapper}" 1927 newexe "${tmpwrapper}" "${wrapper}"
1928 ) || die
1775 else 1929 else
1776 newbin "${tmpwrapper}" "${wrapper}" 1930 newbin "${tmpwrapper}" "${wrapper}" || die
1931 fi
1932}
1933
1934# @FUNCTION: prepalldocs
1935# @USAGE:
1936# @DESCRIPTION:
1937# Compress files in /usr/share/doc which are not already
1938# compressed, excluding /usr/share/doc/${PF}/html.
1939# Uses the ecompressdir to do the compression.
1940# 2009-02-18 by betelgeuse:
1941# Commented because ecompressdir is even more internal to
1942# Portage than prepalldocs (it's not even mentioned in man 5
1943# ebuild). Please submit a better version for review to gentoo-dev
1944# if you want prepalldocs here.
1945#prepalldocs() {
1946# if [[ -n $1 ]] ; then
1947# ewarn "prepalldocs: invalid usage; takes no arguments"
1777 fi 1948# fi
1778} 1949
1950# cd "${D}"
1951# [[ -d usr/share/doc ]] || return 0
1952
1953# find usr/share/doc -exec gzip {} +
1954# ecompressdir --ignore /usr/share/doc/${PF}/html
1955# ecompressdir --queue /usr/share/doc
1956#}

Legend:
Removed from v.1.279  
changed lines
  Added in v.1.345

  ViewVC Help
Powered by ViewVC 1.1.20