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

Contents of /eclass/eutils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.300 - (show annotations) (download)
Sat Mar 1 21:59:54 2008 UTC (6 years, 6 months ago) by vapier
Branch: MAIN
Changes since 1.299: +5 -2 lines
add rm copy & paste lines #212018

1 # Copyright 1999-2007 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.299 2008/02/20 17:32:02 vapier 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.
14 #
15 # Due to the nature of this eclass, some functions may have maintainers
16 # different from the overall eclass!
17
18 inherit multilib portability
19
20 DESCRIPTION="Based on the ${ECLASS} eclass"
21
22 # @FUNCTION: epause
23 # @USAGE: [seconds]
24 # @DESCRIPTION:
25 # Sleep for the specified number of seconds (default of 5 seconds). Useful when
26 # printing a message the user should probably be reading and often used in
27 # conjunction with the ebeep function. If the EPAUSE_IGNORE env var is set,
28 # don't wait at all.
29 epause() {
30 [[ -z ${EPAUSE_IGNORE} ]] && sleep ${1:-5}
31 }
32
33 # @FUNCTION: ebeep
34 # @USAGE: [number of beeps]
35 # @DESCRIPTION:
36 # Issue the specified number of beeps (default of 5 beeps). Useful when
37 # printing a message the user should probably be reading and often used in
38 # conjunction with the epause function. If the EBEEP_IGNORE env var is set,
39 # don't beep at all.
40 ebeep() {
41 local n
42 if [[ -z ${EBEEP_IGNORE} ]] ; then
43 for ((n=1 ; n <= ${1:-5} ; n++)) ; do
44 echo -ne "\a"
45 sleep 0.1 &>/dev/null ; sleep 0,1 &>/dev/null
46 echo -ne "\a"
47 sleep 1
48 done
49 fi
50 }
51
52 # @FUNCTION: ecvs_clean
53 # @USAGE: [list of dirs]
54 # @DESCRIPTION:
55 # Remove CVS directories recursiveley. Useful when a source tarball contains
56 # internal CVS directories. Defaults to $PWD.
57 ecvs_clean() {
58 [[ -z $* ]] && set -- .
59 find "$@" -type d -name 'CVS' -prune -print0 | xargs -0 rm -rf
60 find "$@" -type f -name '.cvs*' -print0 | xargs -0 rm -rf
61 }
62
63 # @FUNCTION: esvn_clean
64 # @USAGE: [list of dirs]
65 # @DESCRIPTION:
66 # Remove .svn directories recursiveley. Useful when a source tarball contains
67 # internal Subversion directories. Defaults to $PWD.
68 esvn_clean() {
69 [[ -z $* ]] && set -- .
70 find "$@" -type d -name '.svn' -prune -print0 | xargs -0 rm -rf
71 }
72
73 # Default directory where patches are located
74 EPATCH_SOURCE="${WORKDIR}/patch"
75 # Default extension for patches
76 EPATCH_SUFFIX="patch.bz2"
77 # Default options for patch
78 # Set -g0 to keep RCS, ClearCase, Perforce and SCCS happy. Bug #24571
79 # Set --no-backup-if-mismatch so we don't leave '.orig' files behind.
80 # Set -E to automatically remove empty files.
81 EPATCH_OPTS="-g0 -E --no-backup-if-mismatch"
82 # List of patches not to apply. Not this is only file names,
83 # and not the full path ..
84 EPATCH_EXCLUDE=""
85 # Change the printed message for a single patch.
86 EPATCH_SINGLE_MSG=""
87 # Change the printed message for multiple patches.
88 EPATCH_MULTI_MSG="Applying various patches (bugfixes/updates) ..."
89 # Force applying bulk patches even if not following the style:
90 #
91 # ??_${ARCH}_foo.${EPATCH_SUFFIX}
92 #
93 EPATCH_FORCE="no"
94
95 # This function is for bulk patching, or in theory for just one
96 # or two patches.
97 #
98 # It should work with .bz2, .gz, .zip and plain text patches.
99 # Currently all patches should be the same format.
100 #
101 # You do not have to specify '-p' option to patch, as it will
102 # try with -p0 to -p5 until it succeed, or fail at -p5.
103 #
104 # Above EPATCH_* variables can be used to control various defaults,
105 # bug they should be left as is to ensure an ebuild can rely on
106 # them for.
107 #
108 # Patches are applied in current directory.
109 #
110 # Bulk Patches should preferibly have the form of:
111 #
112 # ??_${ARCH}_foo.${EPATCH_SUFFIX}
113 #
114 # For example:
115 #
116 # 01_all_misc-fix.patch.bz2
117 # 02_sparc_another-fix.patch.bz2
118 #
119 # This ensures that there are a set order, and you can have ARCH
120 # specific patches.
121 #
122 # If you however give an argument to epatch(), it will treat it as a
123 # single patch that need to be applied if its a file. If on the other
124 # hand its a directory, it will set EPATCH_SOURCE to this.
125 #
126 # <azarah@gentoo.org> (10 Nov 2002)
127 #
128 epatch() {
129 _epatch_draw_line() {
130 [[ -z $1 ]] && set "$(printf "%65s" '')"
131 echo "${1//?/=}"
132 }
133 _epatch_assert() { local _pipestatus=${PIPESTATUS[*]}; [[ ${_pipestatus// /} -eq 0 ]] ; }
134 local PIPE_CMD=""
135 local STDERR_TARGET="${T}/$$.out"
136 local PATCH_TARGET="${T}/$$.patch"
137 local PATCH_SUFFIX=""
138 local SINGLE_PATCH="no"
139 local x=""
140
141 unset P4CONFIG P4PORT P4USER # keep perforce at bay #56402
142
143 if [ "$#" -gt 1 ]
144 then
145 local m=""
146 for m in "$@" ; do
147 epatch "${m}"
148 done
149 return 0
150 fi
151
152 if [ -n "$1" -a -f "$1" ]
153 then
154 SINGLE_PATCH="yes"
155
156 local EPATCH_SOURCE="$1"
157 local EPATCH_SUFFIX="${1##*\.}"
158
159 elif [ -n "$1" -a -d "$1" ]
160 then
161 # Allow no extension if EPATCH_FORCE=yes ... used by vim for example ...
162 if [ "${EPATCH_FORCE}" = "yes" ] && [ -z "${EPATCH_SUFFIX}" ]
163 then
164 local EPATCH_SOURCE="$1/*"
165 else
166 local EPATCH_SOURCE="$1/*.${EPATCH_SUFFIX}"
167 fi
168 else
169 if [[ ! -d ${EPATCH_SOURCE} ]] || [[ -n $1 ]] ; then
170 if [ -n "$1" -a "${EPATCH_SOURCE}" = "${WORKDIR}/patch" ]
171 then
172 EPATCH_SOURCE="$1"
173 fi
174
175 echo
176 eerror "Cannot find \$EPATCH_SOURCE! Value for \$EPATCH_SOURCE is:"
177 eerror
178 eerror " ${EPATCH_SOURCE}"
179 eerror " ( ${EPATCH_SOURCE##*/} )"
180 echo
181 die "Cannot find \$EPATCH_SOURCE!"
182 fi
183
184 local EPATCH_SOURCE="${EPATCH_SOURCE}/*.${EPATCH_SUFFIX}"
185 fi
186
187 case ${EPATCH_SUFFIX##*\.} in
188 bz2)
189 PIPE_CMD="bzip2 -dc"
190 PATCH_SUFFIX="bz2"
191 ;;
192 gz|Z|z)
193 PIPE_CMD="gzip -dc"
194 PATCH_SUFFIX="gz"
195 ;;
196 ZIP|zip)
197 PIPE_CMD="unzip -p"
198 PATCH_SUFFIX="zip"
199 ;;
200 *)
201 PIPE_CMD="cat"
202 PATCH_SUFFIX="patch"
203 ;;
204 esac
205
206 if [ "${SINGLE_PATCH}" = "no" ]
207 then
208 einfo "${EPATCH_MULTI_MSG}"
209 fi
210 for x in ${EPATCH_SOURCE}
211 do
212 # New ARCH dependant patch naming scheme ...
213 #
214 # ???_arch_foo.patch
215 #
216 if [ -f ${x} ] && \
217 ([ "${SINGLE_PATCH}" = "yes" -o "${x/_all_}" != "${x}" -o "${x/_${ARCH}_}" != "${x}" ] || \
218 [ "${EPATCH_FORCE}" = "yes" ])
219 then
220 local count=0
221 local popts="${EPATCH_OPTS}"
222 local patchname=${x##*/}
223
224 if [ -n "${EPATCH_EXCLUDE}" ]
225 then
226 if [ "${EPATCH_EXCLUDE/${patchname}}" != "${EPATCH_EXCLUDE}" ]
227 then
228 continue
229 fi
230 fi
231
232 if [ "${SINGLE_PATCH}" = "yes" ]
233 then
234 if [ -n "${EPATCH_SINGLE_MSG}" ]
235 then
236 einfo "${EPATCH_SINGLE_MSG}"
237 else
238 einfo "Applying ${patchname} ..."
239 fi
240 else
241 einfo " ${patchname} ..."
242 fi
243
244 echo "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
245 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
246
247 # Allow for prefix to differ ... im lazy, so shoot me :/
248 while [ "${count}" -lt 5 ]
249 do
250 # Generate some useful debug info ...
251 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
252 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
253
254 if [ "${PATCH_SUFFIX}" != "patch" ]
255 then
256 echo -n "PIPE_COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
257 echo "${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
258 else
259 PATCH_TARGET="${x}"
260 fi
261
262 echo -n "PATCH COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
263 echo "patch -p${count} ${popts} < ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
264
265 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
266 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
267
268 if [ "${PATCH_SUFFIX}" != "patch" ]
269 then
270 if ! (${PIPE_CMD} ${x} > ${PATCH_TARGET}) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1
271 then
272 echo
273 eerror "Could not extract patch!"
274 #die "Could not extract patch!"
275 count=5
276 break
277 fi
278 fi
279
280 if (cat ${PATCH_TARGET} | patch -p${count} ${popts} --dry-run -f ; _epatch_assert) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1
281 then
282 _epatch_draw_line "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
283 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
284 echo "ACTUALLY APPLYING ${patchname} ..." >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
285 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
286 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
287
288 cat ${PATCH_TARGET} | patch -p${count} ${popts} >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real 2>&1
289 _epatch_assert
290
291 if [ "$?" -ne 0 ]
292 then
293 cat ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
294 echo
295 eerror "A dry-run of patch command succeeded, but actually"
296 eerror "applying the patch failed!"
297 #die "Real world sux compared to the dreamworld!"
298 count=5
299 fi
300
301 rm -f ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
302
303 break
304 fi
305
306 count=$((count + 1))
307 done
308
309 if [ "${PATCH_SUFFIX}" != "patch" ]
310 then
311 rm -f ${PATCH_TARGET}
312 fi
313
314 if [ "${count}" -eq 5 ]
315 then
316 echo
317 eerror "Failed Patch: ${patchname} !"
318 eerror " ( ${PATCH_TARGET} )"
319 eerror
320 eerror "Include in your bugreport the contents of:"
321 eerror
322 eerror " ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}"
323 echo
324 die "Failed Patch: ${patchname}!"
325 fi
326
327 rm -f ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
328
329 eend 0
330 fi
331 done
332 if [ "${SINGLE_PATCH}" = "no" ]
333 then
334 einfo "Done with patching"
335 fi
336 }
337
338 # @FUNCTION: emktemp
339 # @USAGE: [temp dir]
340 # @DESCRIPTION:
341 # Cheap replacement for when debianutils (and thus mktemp)
342 # does not exist on the users system.
343 emktemp() {
344 local exe="touch"
345 [[ $1 == -d ]] && exe="mkdir" && shift
346 local topdir=$1
347
348 if [[ -z ${topdir} ]] ; then
349 [[ -z ${T} ]] \
350 && topdir="/tmp" \
351 || topdir=${T}
352 fi
353
354 if ! type -P mktemp > /dev/null ; then
355 # system lacks `mktemp` so we have to fake it
356 local tmp=/
357 while [[ -e ${tmp} ]] ; do
358 tmp=${topdir}/tmp.${RANDOM}.${RANDOM}.${RANDOM}
359 done
360 ${exe} "${tmp}" || ${exe} -p "${tmp}"
361 echo "${tmp}"
362 else
363 # the args here will give slightly wierd names on BSD,
364 # but should produce a usable file on all userlands
365 if [[ ${exe} == "touch" ]] ; then
366 TMPDIR="${topdir}" mktemp -t tmp.XXXXXXXXXX
367 else
368 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX
369 fi
370 fi
371 }
372
373 # @FUNCTION: egetent
374 # @USAGE: <database> <key>
375 # @MAINTAINER:
376 # base-system@gentoo.org (Linux)
377 # Joe Jezak <josejx@gmail.com> (OS X)
378 # usata@gentoo.org (OS X)
379 # Aaron Walker <ka0ttic@gentoo.org> (FreeBSD)
380 # @DESCRIPTION:
381 # Small wrapper for getent (Linux), nidump (Mac OS X),
382 # and pw (FreeBSD) used in enewuser()/enewgroup()
383 egetent() {
384 case ${CHOST} in
385 *-darwin*)
386 case "$2" in
387 *[!0-9]*) # Non numeric
388 nidump $1 . | awk -F":" "{ if (\$1 ~ /^$2$/) {print \$0;exit;} }"
389 ;;
390 *) # Numeric
391 nidump $1 . | awk -F":" "{ if (\$3 == $2) {print \$0;exit;} }"
392 ;;
393 esac
394 ;;
395 *-freebsd*|*-dragonfly*)
396 local opts action="user"
397 [[ $1 == "passwd" ]] || action="group"
398
399 # lookup by uid/gid
400 if [[ $2 == [[:digit:]]* ]] ; then
401 [[ ${action} == "user" ]] && opts="-u" || opts="-g"
402 fi
403
404 pw show ${action} ${opts} "$2" -q
405 ;;
406 *-netbsd*|*-openbsd*)
407 grep "$2:\*:" /etc/$1
408 ;;
409 *)
410 type -p nscd >& /dev/null && nscd -i "$1"
411 getent "$1" "$2"
412 ;;
413 esac
414 }
415
416 # @FUNCTION: enewuser
417 # @USAGE: <user> [uid] [shell] [homedir] [groups] [params]
418 # @DESCRIPTION:
419 # Same as enewgroup, you are not required to understand how to properly add
420 # a user to the system. The only required parameter is the username.
421 # Default uid is (pass -1 for this) next available, default shell is
422 # /bin/false, default homedir is /dev/null, there are no default groups,
423 # and default params sets the comment as 'added by portage for ${PN}'.
424 enewuser() {
425 case ${EBUILD_PHASE} in
426 unpack|compile|test|install)
427 eerror "'enewuser()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
428 eerror "Package fails at QA and at life. Please file a bug."
429 die "Bad package! enewuser is only for use in pkg_* functions!"
430 esac
431
432 # get the username
433 local euser=$1; shift
434 if [[ -z ${euser} ]] ; then
435 eerror "No username specified !"
436 die "Cannot call enewuser without a username"
437 fi
438
439 # lets see if the username already exists
440 if [[ -n $(egetent passwd "${euser}") ]] ; then
441 return 0
442 fi
443 einfo "Adding user '${euser}' to your system ..."
444
445 # options to pass to useradd
446 local opts=
447
448 # handle uid
449 local euid=$1; shift
450 if [[ -n ${euid} && ${euid} != -1 ]] ; then
451 if [[ ${euid} -gt 0 ]] ; then
452 if [[ -n $(egetent passwd ${euid}) ]] ; then
453 euid="next"
454 fi
455 else
456 eerror "Userid given but is not greater than 0 !"
457 die "${euid} is not a valid UID"
458 fi
459 else
460 euid="next"
461 fi
462 if [[ ${euid} == "next" ]] ; then
463 for ((euid = 101; euid <= 999; euid++)); do
464 [[ -z $(egetent passwd ${euid}) ]] && break
465 done
466 fi
467 opts="${opts} -u ${euid}"
468 einfo " - Userid: ${euid}"
469
470 # handle shell
471 local eshell=$1; shift
472 if [[ ! -z ${eshell} ]] && [[ ${eshell} != "-1" ]] ; then
473 if [[ ! -e ${ROOT}${eshell} ]] ; then
474 eerror "A shell was specified but it does not exist !"
475 die "${eshell} does not exist in ${ROOT}"
476 fi
477 if [[ ${eshell} == */false || ${eshell} == */nologin ]] ; then
478 eerror "Do not specify ${eshell} yourself, use -1"
479 die "Pass '-1' as the shell parameter"
480 fi
481 else
482 for shell in /sbin/nologin /usr/sbin/nologin /bin/false /usr/bin/false /dev/null ; do
483 [[ -x ${ROOT}${shell} ]] && break
484 done
485
486 if [[ ${shell} == "/dev/null" ]] ; then
487 eerror "Unable to identify the shell to use, proceeding with userland default."
488 case ${USERLAND} in
489 GNU) shell="/bin/false" ;;
490 BSD) shell="/sbin/nologin" ;;
491 Darwin) shell="/usr/sbin/nologin" ;;
492 *) die "Unable to identify the default shell for userland ${USERLAND}"
493 esac
494 fi
495
496 eshell=${shell}
497 fi
498 einfo " - Shell: ${eshell}"
499 opts="${opts} -s ${eshell}"
500
501 # handle homedir
502 local ehome=$1; shift
503 if [[ -z ${ehome} ]] || [[ ${ehome} == "-1" ]] ; then
504 ehome="/dev/null"
505 fi
506 einfo " - Home: ${ehome}"
507 opts="${opts} -d ${ehome}"
508
509 # handle groups
510 local egroups=$1; shift
511 if [[ ! -z ${egroups} ]] ; then
512 local oldifs=${IFS}
513 local defgroup="" exgroups=""
514
515 export IFS=","
516 for g in ${egroups} ; do
517 export IFS=${oldifs}
518 if [[ -z $(egetent group "${g}") ]] ; then
519 eerror "You must add group ${g} to the system first"
520 die "${g} is not a valid GID"
521 fi
522 if [[ -z ${defgroup} ]] ; then
523 defgroup=${g}
524 else
525 exgroups="${exgroups},${g}"
526 fi
527 export IFS=","
528 done
529 export IFS=${oldifs}
530
531 opts="${opts} -g ${defgroup}"
532 if [[ ! -z ${exgroups} ]] ; then
533 opts="${opts} -G ${exgroups:1}"
534 fi
535 else
536 egroups="(none)"
537 fi
538 einfo " - Groups: ${egroups}"
539
540 # handle extra and add the user
541 local oldsandbox=${SANDBOX_ON}
542 export SANDBOX_ON="0"
543 case ${CHOST} in
544 *-darwin*)
545 ### Make the user
546 if [[ -z $@ ]] ; then
547 dscl . create /users/${euser} uid ${euid}
548 dscl . create /users/${euser} shell ${eshell}
549 dscl . create /users/${euser} home ${ehome}
550 dscl . create /users/${euser} realname "added by portage for ${PN}"
551 ### Add the user to the groups specified
552 local oldifs=${IFS}
553 export IFS=","
554 for g in ${egroups} ; do
555 dscl . merge /groups/${g} users ${euser}
556 done
557 export IFS=${oldifs}
558 else
559 einfo "Extra options are not supported on Darwin yet"
560 einfo "Please report the ebuild along with the info below"
561 einfo "eextra: $@"
562 die "Required function missing"
563 fi
564 ;;
565 *-freebsd*|*-dragonfly*)
566 if [[ -z $@ ]] ; then
567 pw useradd ${euser} ${opts} \
568 -c "added by portage for ${PN}" \
569 die "enewuser failed"
570 else
571 einfo " - Extra: $@"
572 pw useradd ${euser} ${opts} \
573 "$@" || die "enewuser failed"
574 fi
575 ;;
576
577 *-netbsd*)
578 if [[ -z $@ ]] ; then
579 useradd ${opts} ${euser} || die "enewuser failed"
580 else
581 einfo " - Extra: $@"
582 useradd ${opts} ${euser} "$@" || die "enewuser failed"
583 fi
584 ;;
585
586 *-openbsd*)
587 if [[ -z $@ ]] ; then
588 useradd -u ${euid} -s ${eshell} \
589 -d ${ehome} -c "Added by portage for ${PN}" \
590 -g ${egroups} ${euser} || die "enewuser failed"
591 else
592 einfo " - Extra: $@"
593 useradd -u ${euid} -s ${eshell} \
594 -d ${ehome} -c "Added by portage for ${PN}" \
595 -g ${egroups} ${euser} "$@" || die "enewuser failed"
596 fi
597 ;;
598
599 *)
600 if [[ -z $@ ]] ; then
601 useradd ${opts} ${euser} \
602 -c "added by portage for ${PN}" \
603 || die "enewuser failed"
604 else
605 einfo " - Extra: $@"
606 useradd ${opts} ${euser} "$@" \
607 || die "enewuser failed"
608 fi
609 ;;
610 esac
611
612 if [[ ! -e ${ROOT}/${ehome} ]] ; then
613 einfo " - Creating ${ehome} in ${ROOT}"
614 mkdir -p "${ROOT}/${ehome}"
615 chown ${euser} "${ROOT}/${ehome}"
616 chmod 755 "${ROOT}/${ehome}"
617 fi
618
619 export SANDBOX_ON=${oldsandbox}
620 }
621
622 # @FUNCTION: enewgroup
623 # @USAGE: <group> [gid]
624 # @DESCRIPTION:
625 # This function does not require you to understand how to properly add a
626 # group to the system. Just give it a group name to add and enewgroup will
627 # do the rest. You may specify the gid for the group or allow the group to
628 # allocate the next available one.
629 enewgroup() {
630 case ${EBUILD_PHASE} in
631 unpack|compile|test|install)
632 eerror "'enewgroup()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
633 eerror "Package fails at QA and at life. Please file a bug."
634 die "Bad package! enewgroup is only for use in pkg_* functions!"
635 esac
636
637 # get the group
638 local egroup="$1"; shift
639 if [ -z "${egroup}" ]
640 then
641 eerror "No group specified !"
642 die "Cannot call enewgroup without a group"
643 fi
644
645 # see if group already exists
646 if [[ -n $(egetent group "${egroup}") ]]; then
647 return 0
648 fi
649 einfo "Adding group '${egroup}' to your system ..."
650
651 # options to pass to useradd
652 local opts=
653
654 # handle gid
655 local egid="$1"; shift
656 if [ ! -z "${egid}" ]
657 then
658 if [ "${egid}" -gt 0 ]
659 then
660 if [ -z "`egetent group ${egid}`" ]
661 then
662 if [[ "${CHOST}" == *-darwin* ]]; then
663 opts="${opts} ${egid}"
664 else
665 opts="${opts} -g ${egid}"
666 fi
667 else
668 egid="next available; requested gid taken"
669 fi
670 else
671 eerror "Groupid given but is not greater than 0 !"
672 die "${egid} is not a valid GID"
673 fi
674 else
675 egid="next available"
676 fi
677 einfo " - Groupid: ${egid}"
678
679 # handle extra
680 local eextra="$@"
681 opts="${opts} ${eextra}"
682
683 # add the group
684 local oldsandbox="${SANDBOX_ON}"
685 export SANDBOX_ON="0"
686 case ${CHOST} in
687 *-darwin*)
688 if [ ! -z "${eextra}" ];
689 then
690 einfo "Extra options are not supported on Darwin/OS X yet"
691 einfo "Please report the ebuild along with the info below"
692 einfo "eextra: ${eextra}"
693 die "Required function missing"
694 fi
695
696 # If we need the next available
697 case ${egid} in
698 *[!0-9]*) # Non numeric
699 for ((egid = 101; egid <= 999; egid++)); do
700 [[ -z $(egetent group ${egid}) ]] && break
701 done
702 esac
703 dscl . create /groups/${egroup} gid ${egid}
704 dscl . create /groups/${egroup} passwd '*'
705 ;;
706
707 *-freebsd*|*-dragonfly*)
708 case ${egid} in
709 *[!0-9]*) # Non numeric
710 for ((egid = 101; egid <= 999; egid++)); do
711 [[ -z $(egetent group ${egid}) ]] && break
712 done
713 esac
714 pw groupadd ${egroup} -g ${egid} || die "enewgroup failed"
715 ;;
716
717 *-netbsd*)
718 case ${egid} in
719 *[!0-9]*) # Non numeric
720 for ((egid = 101; egid <= 999; egid++)); do
721 [[ -z $(egetent group ${egid}) ]] && break
722 done
723 esac
724 groupadd -g ${egid} ${egroup} || die "enewgroup failed"
725 ;;
726
727 *)
728 groupadd ${opts} ${egroup} || die "enewgroup failed"
729 ;;
730 esac
731 export SANDBOX_ON="${oldsandbox}"
732 }
733
734 # @FUNCTION: edos2unix
735 # @USAGE: <file> [more files ...]
736 # @DESCRIPTION:
737 # A handy replacement for dos2unix, recode, fixdos, etc... This allows you
738 # to remove all of these text utilities from DEPEND variables because this
739 # is a script based solution. Just give it a list of files to convert and
740 # they will all be changed from the DOS CRLF format to the UNIX LF format.
741 edos2unix() {
742 echo "$@" | xargs sed -i 's/\r$//'
743 }
744
745 # Make a desktop file !
746 # Great for making those icons in kde/gnome startmenu !
747 # Amaze your friends ! Get the women ! Join today !
748 #
749 # make_desktop_entry(<command>, [name], [icon], [type], [path])
750 #
751 # binary: what command does the app run with ?
752 # name: the name that will show up in the menu
753 # icon: give your little like a pretty little icon ...
754 # this can be relative (to /usr/share/pixmaps) or
755 # a full path to an icon
756 # type: what kind of application is this ? for categories:
757 # http://standards.freedesktop.org/menu-spec/latest/apa.html
758 # path: if your app needs to startup in a specific dir
759 make_desktop_entry() {
760 [[ -z $1 ]] && eerror "make_desktop_entry: You must specify the executable" && return 1
761
762 local exec=${1}
763 local name=${2:-${PN}}
764 local icon=${3:-${PN}}
765 local type=${4}
766 local path=${5}
767
768 if [[ -z ${type} ]] ; then
769 local catmaj=${CATEGORY%%-*}
770 local catmin=${CATEGORY##*-}
771 case ${catmaj} in
772 app)
773 case ${catmin} in
774 accessibility) type=Accessibility;;
775 admin) type=System;;
776 antivirus) type=System;;
777 arch) type=Archiving;;
778 backup) type=Archiving;;
779 cdr) type=DiscBurning;;
780 dicts) type=Dictionary;;
781 doc) type=Documentation;;
782 editors) type=TextEditor;;
783 emacs) type=TextEditor;;
784 emulation) type=Emulator;;
785 laptop) type=HardwareSettings;;
786 office) type=Office;;
787 pda) type=PDA;;
788 vim) type=TextEditor;;
789 xemacs) type=TextEditor;;
790 *) type=;;
791 esac
792 ;;
793
794 dev)
795 type="Development"
796 ;;
797
798 games)
799 case ${catmin} in
800 action|fps) type=ActionGame;;
801 arcade) type=ArcadeGame;;
802 board) type=BoardGame;;
803 emulation) type=Emulator;;
804 kids) type=KidsGame;;
805 puzzle) type=LogicGame;;
806 roguelike) type=RolePlaying;;
807 rpg) type=RolePlaying;;
808 simulation) type=Simulation;;
809 sports) type=SportsGame;;
810 strategy) type=StrategyGame;;
811 *) type=;;
812 esac
813 type="Game;${type}"
814 ;;
815
816 gnome)
817 type="Gnome;GTK"
818 ;;
819
820 kde)
821 type="KDE;Qt"
822 ;;
823
824 mail)
825 type="Network;Email"
826 ;;
827
828 media)
829 case ${catmin} in
830 gfx) type=Graphics;;
831 radio) type=Tuner;;
832 sound) type=Audio;;
833 tv) type=TV;;
834 video) type=Video;;
835 *) type=;;
836 esac
837 type="AudioVideo;${type}"
838 ;;
839
840 net)
841 case ${catmin} in
842 dialup) type=Dialup;;
843 ftp) type=FileTransfer;;
844 im) type=InstantMessaging;;
845 irc) type=IRCClient;;
846 mail) type=Email;;
847 news) type=News;;
848 nntp) type=News;;
849 p2p) type=FileTransfer;;
850 *) type=;;
851 esac
852 type="Network;${type}"
853 ;;
854
855 sci)
856 case ${catmin} in
857 astro*) type=Astronomy;;
858 bio*) type=Biology;;
859 calc*) type=Calculator;;
860 chem*) type=Chemistry;;
861 elec*) type=Electronics;;
862 geo*) type=Geology;;
863 math*) type=Math;;
864 physics) type=Physics;;
865 visual*) type=DataVisualization;;
866 *) type=;;
867 esac
868 type="Science;${type}"
869 ;;
870
871 sys)
872 type="System"
873 ;;
874
875 www)
876 case ${catmin} in
877 client) type=WebBrowser;;
878 *) type=;;
879 esac
880 type="Network"
881 ;;
882
883 *)
884 type=
885 ;;
886 esac
887 fi
888 if [ "${SLOT}" == "0" ] ; then
889 local desktop_name="${PN}"
890 else
891 local desktop_name="${PN}-${SLOT}"
892 fi
893 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop"
894 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop
895
896 cat <<-EOF > "${desktop}"
897 [Desktop Entry]
898 Version=1.0
899 Name=${name}
900 Type=Application
901 Comment=${DESCRIPTION}
902 Exec=${exec}
903 TryExec=${exec%% *}
904 Icon=${icon}
905 Categories=${type};
906 EOF
907
908 [[ ${path} ]] && echo "Path=${path}" >> "${desktop}"
909
910 (
911 # wrap the env here so that the 'insinto' call
912 # doesn't corrupt the env of the caller
913 insinto /usr/share/applications
914 doins "${desktop}"
915 )
916 }
917
918 # @FUNCTION: validate_desktop_entries
919 # @USAGE: [directories]
920 # @MAINTAINER:
921 # Carsten Lohrke <carlo@gentoo.org>
922 # @DESCRIPTION:
923 # Validate desktop entries using desktop-file-utils
924 validate_desktop_entries() {
925 if [[ -x /usr/bin/desktop-file-validate ]] ; then
926 einfo "Checking desktop entry validity"
927 local directories=""
928 for d in /usr/share/applications $@ ; do
929 [[ -d ${D}${d} ]] && directories="${directories} ${D}${d}"
930 done
931 if [[ -n ${directories} ]] ; then
932 for FILE in $(find ${directories} -name "*\.desktop" \
933 -not -path '*.hidden*' | sort -u 2>/dev/null)
934 do
935 local temp=$(desktop-file-validate ${FILE} | grep -v "warning:" | \
936 sed -e "s|error: ||" -e "s|${FILE}:|--|g" )
937 [[ -n $temp ]] && elog ${temp/--/${FILE/${D}/}:}
938 done
939 fi
940 echo ""
941 else
942 einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo."
943 fi
944 }
945
946 # @FUNCTION: make_session_desktop
947 # @USAGE: <title> <command>
948 # @DESCRIPTION:
949 # Make a GDM/KDM Session file. The title is the file to execute to start the
950 # Window Manager. The command is the name of the Window Manager.
951 make_session_desktop() {
952 [[ -z $1 ]] && eerror "make_session_desktop: You must specify the title" && return 1
953 [[ -z $2 ]] && eerror "make_session_desktop: You must specify the command" && return 1
954
955 local title=$1
956 local command=$2
957 local desktop=${T}/${wm}.desktop
958
959 cat <<-EOF > "${desktop}"
960 [Desktop Entry]
961 Name=${title}
962 Comment=This session logs you into ${title}
963 Exec=${command}
964 TryExec=${command}
965 Type=Application
966 EOF
967
968 (
969 # wrap the env here so that the 'insinto' call
970 # doesn't corrupt the env of the caller
971 insinto /usr/share/xsessions
972 doins "${desktop}"
973 )
974 }
975
976 # @FUNCTION: domenu
977 # @USAGE: <menus>
978 # @DESCRIPTION:
979 # Install the list of .desktop menu files into the appropriate directory
980 # (/usr/share/applications).
981 domenu() {
982 (
983 # wrap the env here so that the 'insinto' call
984 # doesn't corrupt the env of the caller
985 local i j ret=0
986 insinto /usr/share/applications
987 for i in "$@" ; do
988 if [[ -f ${i} ]] ; then
989 doins "${i}"
990 ((ret+=$?))
991 elif [[ -d ${i} ]] ; then
992 for j in "${i}"/*.desktop ; do
993 doins "${j}"
994 ((ret+=$?))
995 done
996 else
997 ((++ret))
998 fi
999 done
1000 exit ${ret}
1001 )
1002 }
1003
1004 # @FUNCTION: newmenu
1005 # @USAGE: <menu> <newname>
1006 # @DESCRIPTION:
1007 # Like all other new* functions, install the specified menu as newname.
1008 newmenu() {
1009 (
1010 # wrap the env here so that the 'insinto' call
1011 # doesn't corrupt the env of the caller
1012 insinto /usr/share/applications
1013 newins "$@"
1014 )
1015 }
1016
1017 # @FUNCTION: doicon
1018 # @USAGE: <list of icons>
1019 # @DESCRIPTION:
1020 # Install the list of icons into the icon directory (/usr/share/pixmaps).
1021 # This is useful in conjunction with creating desktop/menu files.
1022 doicon() {
1023 (
1024 # wrap the env here so that the 'insinto' call
1025 # doesn't corrupt the env of the caller
1026 local i j ret
1027 insinto /usr/share/pixmaps
1028 for i in "$@" ; do
1029 if [[ -f ${i} ]] ; then
1030 doins "${i}"
1031 ((ret+=$?))
1032 elif [[ -d ${i} ]] ; then
1033 for j in "${i}"/*.png ; do
1034 doins "${j}"
1035 ((ret+=$?))
1036 done
1037 else
1038 ((++ret))
1039 fi
1040 done
1041 exit ${ret}
1042 )
1043 }
1044
1045 # @FUNCTION: newicon
1046 # @USAGE: <icon> <newname>
1047 # @DESCRIPTION:
1048 # Like all other new* functions, install the specified icon as newname.
1049 newicon() {
1050 (
1051 # wrap the env here so that the 'insinto' call
1052 # doesn't corrupt the env of the caller
1053 insinto /usr/share/pixmaps
1054 newins "$@"
1055 )
1056 }
1057
1058 # for internal use only (unpack_pdv and unpack_makeself)
1059 find_unpackable_file() {
1060 local src=$1
1061 if [[ -z ${src} ]] ; then
1062 src=${DISTDIR}/${A}
1063 else
1064 if [[ -e ${DISTDIR}/${src} ]] ; then
1065 src=${DISTDIR}/${src}
1066 elif [[ -e ${PWD}/${src} ]] ; then
1067 src=${PWD}/${src}
1068 elif [[ -e ${src} ]] ; then
1069 src=${src}
1070 fi
1071 fi
1072 [[ ! -e ${src} ]] && return 1
1073 echo "${src}"
1074 }
1075
1076 # @FUNCTION: unpack_pdv
1077 # @USAGE: <file to unpack> <size of off_t>
1078 # @DESCRIPTION:
1079 # Unpack those pesky pdv generated files ...
1080 # They're self-unpacking programs with the binary package stuffed in
1081 # the middle of the archive. Valve seems to use it a lot ... too bad
1082 # it seems to like to segfault a lot :(. So lets take it apart ourselves.
1083 #
1084 # You have to specify the off_t size ... I have no idea how to extract that
1085 # information out of the binary executable myself. Basically you pass in
1086 # the size of the off_t type (in bytes) on the machine that built the pdv
1087 # archive.
1088 #
1089 # One way to determine this is by running the following commands:
1090 #
1091 # @CODE
1092 # strings <pdv archive> | grep lseek
1093 # strace -elseek <pdv archive>
1094 # @CODE
1095 #
1096 # Basically look for the first lseek command (we do the strings/grep because
1097 # sometimes the function call is _llseek or something) and steal the 2nd
1098 # parameter. Here is an example:
1099 #
1100 # @CODE
1101 # vapier@vapier 0 pdv_unpack # strings hldsupdatetool.bin | grep lseek
1102 # lseek
1103 # vapier@vapier 0 pdv_unpack # strace -elseek ./hldsupdatetool.bin
1104 # lseek(3, -4, SEEK_END) = 2981250
1105 # @CODE
1106 #
1107 # Thus we would pass in the value of '4' as the second parameter.
1108 unpack_pdv() {
1109 local src=$(find_unpackable_file "$1")
1110 local sizeoff_t=$2
1111
1112 [[ -z ${src} ]] && die "Could not locate source for '$1'"
1113 [[ -z ${sizeoff_t} ]] && die "No idea what off_t size was used for this pdv :("
1114
1115 local shrtsrc=$(basename "${src}")
1116 echo ">>> Unpacking ${shrtsrc} to ${PWD}"
1117 local metaskip=$(tail -c ${sizeoff_t} "${src}" | hexdump -e \"%i\")
1118 local tailskip=$(tail -c $((${sizeoff_t}*2)) "${src}" | head -c ${sizeoff_t} | hexdump -e \"%i\")
1119
1120 # grab metadata for debug reasons
1121 local metafile=$(emktemp)
1122 tail -c +$((${metaskip}+1)) "${src}" > "${metafile}"
1123
1124 # rip out the final file name from the metadata
1125 local datafile=$(tail -c +$((${metaskip}+1)) "${src}" | strings | head -n 1)
1126 datafile=$(basename "${datafile}")
1127
1128 # now lets uncompress/untar the file if need be
1129 local tmpfile=$(emktemp)
1130 tail -c +$((${tailskip}+1)) ${src} 2>/dev/null | head -c 512 > ${tmpfile}
1131
1132 local iscompressed=$(file -b "${tmpfile}")
1133 if [[ ${iscompressed:0:8} == "compress" ]] ; then
1134 iscompressed=1
1135 mv ${tmpfile}{,.Z}
1136 gunzip ${tmpfile}
1137 else
1138 iscompressed=0
1139 fi
1140 local istar=$(file -b "${tmpfile}")
1141 if [[ ${istar:0:9} == "POSIX tar" ]] ; then
1142 istar=1
1143 else
1144 istar=0
1145 fi
1146
1147 #for some reason gzip dies with this ... dd cant provide buffer fast enough ?
1148 #dd if=${src} ibs=${metaskip} count=1 \
1149 # | dd ibs=${tailskip} skip=1 \
1150 # | gzip -dc \
1151 # > ${datafile}
1152 if [ ${iscompressed} -eq 1 ] ; then
1153 if [ ${istar} -eq 1 ] ; then
1154 tail -c +$((${tailskip}+1)) ${src} 2>/dev/null \
1155 | head -c $((${metaskip}-${tailskip})) \
1156 | tar -xzf -
1157 else
1158 tail -c +$((${tailskip}+1)) ${src} 2>/dev/null \
1159 | head -c $((${metaskip}-${tailskip})) \
1160 | gzip -dc \
1161 > ${datafile}
1162 fi
1163 else
1164 if [ ${istar} -eq 1 ] ; then
1165 tail -c +$((${tailskip}+1)) ${src} 2>/dev/null \
1166 | head -c $((${metaskip}-${tailskip})) \
1167 | tar --no-same-owner -xf -
1168 else
1169 tail -c +$((${tailskip}+1)) ${src} 2>/dev/null \
1170 | head -c $((${metaskip}-${tailskip})) \
1171 > ${datafile}
1172 fi
1173 fi
1174 true
1175 #[ -s "${datafile}" ] || die "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
1176 #assert "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
1177 }
1178
1179 # @FUNCTION: unpack_makeself
1180 # @USAGE: [file to unpack] [offset] [tail|dd]
1181 # @DESCRIPTION:
1182 # Unpack those pesky makeself generated files ...
1183 # They're shell scripts with the binary package tagged onto
1184 # the end of the archive. Loki utilized the format as does
1185 # many other game companies.
1186 #
1187 # If the file is not specified, then ${A} is used. If the
1188 # offset is not specified then we will attempt to extract
1189 # the proper offset from the script itself.
1190 unpack_makeself() {
1191 local src_input=${1:-${A}}
1192 local src=$(find_unpackable_file "${src_input}")
1193 local skip=$2
1194 local exe=$3
1195
1196 [[ -z ${src} ]] && die "Could not locate source for '${src_input}'"
1197
1198 local shrtsrc=$(basename "${src}")
1199 echo ">>> Unpacking ${shrtsrc} to ${PWD}"
1200 if [[ -z ${skip} ]] ; then
1201 local ver=$(grep -a '#.*Makeself' "${src}" | awk '{print $NF}')
1202 local skip=0
1203 exe=tail
1204 case ${ver} in
1205 1.5.*|1.6.0-nv) # tested 1.5.{3,4,5} ... guessing 1.5.x series is same
1206 skip=$(grep -a ^skip= "${src}" | cut -d= -f2)
1207 ;;
1208 2.0|2.0.1)
1209 skip=$(grep -a ^$'\t'tail "${src}" | awk '{print $2}' | cut -b2-)
1210 ;;
1211 2.1.1)
1212 skip=$(grep -a ^offset= "${src}" | awk '{print $2}' | cut -b2-)
1213 let skip="skip + 1"
1214 ;;
1215 2.1.2)
1216 skip=$(grep -a ^offset= "${src}" | awk '{print $3}' | head -n 1)
1217 let skip="skip + 1"
1218 ;;
1219 2.1.3)
1220 skip=`grep -a ^offset= "${src}" | awk '{print $3}'`
1221 let skip="skip + 1"
1222 ;;
1223 2.1.4|2.1.5)
1224 skip=$(grep -a offset=.*head.*wc "${src}" | awk '{print $3}' | head -n 1)
1225 skip=$(head -n ${skip} "${src}" | wc -c)
1226 exe="dd"
1227 ;;
1228 *)
1229 eerror "I'm sorry, but I was unable to support the Makeself file."
1230 eerror "The version I detected was '${ver}'."
1231 eerror "Please file a bug about the file ${shrtsrc} at"
1232 eerror "http://bugs.gentoo.org/ so that support can be added."
1233 die "makeself version '${ver}' not supported"
1234 ;;
1235 esac
1236 debug-print "Detected Makeself version ${ver} ... using ${skip} as offset"
1237 fi
1238 case ${exe} in
1239 tail) exe="tail -n +${skip} '${src}'";;
1240 dd) exe="dd ibs=${skip} skip=1 obs=1024 conv=sync if='${src}'";;
1241 *) die "makeself cant handle exe '${exe}'"
1242 esac
1243
1244 # lets grab the first few bytes of the file to figure out what kind of archive it is
1245 local tmpfile=$(emktemp)
1246 eval ${exe} 2>/dev/null | head -c 512 > "${tmpfile}"
1247 local filetype=$(file -b "${tmpfile}")
1248 case ${filetype} in
1249 *tar\ archive*)
1250 eval ${exe} | tar --no-same-owner -xf -
1251 ;;
1252 bzip2*)
1253 eval ${exe} | bzip2 -dc | tar --no-same-owner -xf -
1254 ;;
1255 gzip*)
1256 eval ${exe} | tar --no-same-owner -xzf -
1257 ;;
1258 compress*)
1259 eval ${exe} | gunzip | tar --no-same-owner -xf -
1260 ;;
1261 *)
1262 eerror "Unknown filetype \"${filetype}\" ?"
1263 false
1264 ;;
1265 esac
1266 assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})"
1267 }
1268
1269 # @FUNCTION: check_license
1270 # @USAGE: [license]
1271 # @DESCRIPTION:
1272 # Display a license for user to accept. If no license is
1273 # specified, then ${LICENSE} is used.
1274 check_license() {
1275 local lic=$1
1276 if [ -z "${lic}" ] ; then
1277 lic="${PORTDIR}/licenses/${LICENSE}"
1278 else
1279 if [ -e "${PORTDIR}/licenses/${lic}" ] ; then
1280 lic="${PORTDIR}/licenses/${lic}"
1281 elif [ -e "${PWD}/${lic}" ] ; then
1282 lic="${PWD}/${lic}"
1283 elif [ -e "${lic}" ] ; then
1284 lic="${lic}"
1285 fi
1286 fi
1287 [ ! -f "${lic}" ] && die "Could not find requested license ${lic}"
1288 local l="`basename ${lic}`"
1289
1290 # here is where we check for the licenses the user already
1291 # accepted ... if we don't find a match, we make the user accept
1292 local shopts=$-
1293 local alic
1294 set -o noglob #so that bash doesn't expand "*"
1295 for alic in ${ACCEPT_LICENSE} ; do
1296 if [[ ${alic} == ${l} ]]; then
1297 set +o noglob; set -${shopts} #reset old shell opts
1298 return 0
1299 fi
1300 done
1301 set +o noglob; set -$shopts #reset old shell opts
1302
1303 local licmsg=$(emktemp)
1304 cat <<-EOF > ${licmsg}
1305 **********************************************************
1306 The following license outlines the terms of use of this
1307 package. You MUST accept this license for installation to
1308 continue. When you are done viewing, hit 'q'. If you
1309 CTRL+C out of this, the install will not run!
1310 **********************************************************
1311
1312 EOF
1313 cat ${lic} >> ${licmsg}
1314 ${PAGER:-less} ${licmsg} || die "Could not execute pager (${PAGER}) to accept ${lic}"
1315 einfon "Do you accept the terms of this license (${l})? [yes/no] "
1316 read alic
1317 case ${alic} in
1318 yes|Yes|y|Y)
1319 return 0
1320 ;;
1321 *)
1322 echo;echo;echo
1323 eerror "You MUST accept the license to continue! Exiting!"
1324 die "Failed to accept license"
1325 ;;
1326 esac
1327 }
1328
1329 # @FUNCTION: cdrom_get_cds
1330 # @USAGE: <file on cd1> [file on cd2] [file on cd3] [...]
1331 # @DESCRIPTION:
1332 # Aquire cd(s) for those lovely cd-based emerges. Yes, this violates
1333 # the whole 'non-interactive' policy, but damnit I want CD support !
1334 #
1335 # With these cdrom functions we handle all the user interaction and
1336 # standardize everything. All you have to do is call cdrom_get_cds()
1337 # and when the function returns, you can assume that the cd has been
1338 # found at CDROM_ROOT.
1339 #
1340 # The function will attempt to locate a cd based upon a file that is on
1341 # the cd. The more files you give this function, the more cds
1342 # the cdrom functions will handle.
1343 #
1344 # Normally the cdrom functions will refer to the cds as 'cd #1', 'cd #2',
1345 # etc... If you want to give the cds better names, then just export
1346 # the appropriate CDROM_NAME variable before calling cdrom_get_cds().
1347 # Use CDROM_NAME for one cd, or CDROM_NAME_# for multiple cds. You can
1348 # also use the CDROM_NAME_SET bash array.
1349 #
1350 # For those multi cd ebuilds, see the cdrom_load_next_cd() function.
1351 cdrom_get_cds() {
1352 # first we figure out how many cds we're dealing with by
1353 # the # of files they gave us
1354 local cdcnt=0
1355 local f=
1356 for f in "$@" ; do
1357 ((++cdcnt))
1358 export CDROM_CHECK_${cdcnt}="$f"
1359 done
1360 export CDROM_TOTAL_CDS=${cdcnt}
1361 export CDROM_CURRENT_CD=1
1362
1363 # now we see if the user gave use CD_ROOT ...
1364 # if they did, let's just believe them that it's correct
1365 if [[ -n ${CD_ROOT}${CD_ROOT_1} ]] ; then
1366 local var=
1367 cdcnt=0
1368 while [[ ${cdcnt} -lt ${CDROM_TOTAL_CDS} ]] ; do
1369 ((++cdcnt))
1370 var="CD_ROOT_${cdcnt}"
1371 [[ -z ${!var} ]] && var="CD_ROOT"
1372 if [[ -z ${!var} ]] ; then
1373 eerror "You must either use just the CD_ROOT"
1374 eerror "or specify ALL the CD_ROOT_X variables."
1375 eerror "In this case, you will need ${CDROM_TOTAL_CDS} CD_ROOT_X variables."
1376 die "could not locate CD_ROOT_${cdcnt}"
1377 fi
1378 done
1379 export CDROM_ROOT=${CD_ROOT_1:-${CD_ROOT}}
1380 einfo "Found CD #${CDROM_CURRENT_CD} root at ${CDROM_ROOT}"
1381 export CDROM_SET=-1
1382 for f in ${CDROM_CHECK_1//:/ } ; do
1383 ((++CDROM_SET))
1384 [[ -e ${CD_ROOT}/${f} ]] && break
1385 done
1386 export CDROM_MATCH=${f}
1387 return
1388 fi
1389
1390 # User didn't help us out so lets make sure they know they can
1391 # simplify the whole process ...
1392 if [[ ${CDROM_TOTAL_CDS} -eq 1 ]] ; then
1393 einfo "This ebuild will need the ${CDROM_NAME:-cdrom for ${PN}}"
1394 echo
1395 einfo "If you do not have the CD, but have the data files"
1396 einfo "mounted somewhere on your filesystem, just export"
1397 einfo "the variable CD_ROOT so that it points to the"
1398 einfo "directory containing the files."
1399 echo
1400 einfo "For example:"
1401 einfo "export CD_ROOT=/mnt/cdrom"
1402 echo
1403 else
1404 if [[ -n ${CDROM_NAME_SET} ]] ; then
1405 # Translate the CDROM_NAME_SET array into CDROM_NAME_#
1406 cdcnt=0
1407 while [[ ${cdcnt} -lt ${CDROM_TOTAL_CDS} ]] ; do
1408 ((++cdcnt))
1409 export CDROM_NAME_${cdcnt}="${CDROM_NAME_SET[$((${cdcnt}-1))]}"
1410 done
1411 fi
1412
1413 einfo "This package will need access to ${CDROM_TOTAL_CDS} cds."
1414 cdcnt=0
1415 while [[ ${cdcnt} -lt ${CDROM_TOTAL_CDS} ]] ; do
1416 ((++cdcnt))
1417 var="CDROM_NAME_${cdcnt}"
1418 [[ ! -z ${!var} ]] && einfo " CD ${cdcnt}: ${!var}"
1419 done
1420 echo
1421 einfo "If you do not have the CDs, but have the data files"
1422 einfo "mounted somewhere on your filesystem, just export"
1423 einfo "the following variables so they point to the right place:"
1424 einfon ""
1425 cdcnt=0
1426 while [[ ${cdcnt} -lt ${CDROM_TOTAL_CDS} ]] ; do
1427 ((++cdcnt))
1428 echo -n " CD_ROOT_${cdcnt}"
1429 done
1430 echo
1431 einfo "Or, if you have all the files in the same place, or"
1432 einfo "you only have one cdrom, you can export CD_ROOT"
1433 einfo "and that place will be used as the same data source"
1434 einfo "for all the CDs."
1435 echo
1436 einfo "For example:"
1437 einfo "export CD_ROOT_1=/mnt/cdrom"
1438 echo
1439 fi
1440
1441 export CDROM_SET=""
1442 export CDROM_CURRENT_CD=0
1443 cdrom_load_next_cd
1444 }
1445
1446 # @FUNCTION: cdrom_load_next_cd
1447 # @DESCRIPTION:
1448 # Some packages are so big they come on multiple CDs. When you're done reading
1449 # files off a CD and want access to the next one, just call this function.
1450 # Again, all the messy details of user interaction are taken care of for you.
1451 # Once this returns, just read the variable CDROM_ROOT for the location of the
1452 # mounted CD. Note that you can only go forward in the CD list, so make sure
1453 # you only call this function when you're done using the current CD.
1454 cdrom_load_next_cd() {
1455 local var
1456 ((++CDROM_CURRENT_CD))
1457
1458 unset CDROM_ROOT
1459 var=CD_ROOT_${CDROM_CURRENT_CD}
1460 [[ -z ${!var} ]] && var="CD_ROOT"
1461 if [[ -z ${!var} ]] ; then
1462 var="CDROM_CHECK_${CDROM_CURRENT_CD}"
1463 _cdrom_locate_file_on_cd ${!var}
1464 else
1465 export CDROM_ROOT=${!var}
1466 fi
1467
1468 einfo "Found CD #${CDROM_CURRENT_CD} root at ${CDROM_ROOT}"
1469 }
1470
1471 # this is used internally by the cdrom_get_cds() and cdrom_load_next_cd()
1472 # functions. this should *never* be called from an ebuild.
1473 # all it does is try to locate a give file on a cd ... if the cd isn't
1474 # found, then a message asking for the user to insert the cdrom will be
1475 # displayed and we'll hang out here until:
1476 # (1) the file is found on a mounted cdrom
1477 # (2) the user hits CTRL+C
1478 _cdrom_locate_file_on_cd() {
1479 local mline=""
1480 local showedmsg=0 showjolietmsg=0
1481
1482 while [[ -z ${CDROM_ROOT} ]] ; do
1483 local i=0
1484 local -a cdset=(${*//:/ })
1485 if [[ -n ${CDROM_SET} ]] ; then
1486 cdset=(${cdset[${CDROM_SET}]})
1487 fi
1488
1489 while [[ -n ${cdset[${i}]} ]] ; do
1490 local dir=$(dirname ${cdset[${i}]})
1491 local file=$(basename ${cdset[${i}]})
1492
1493 local point= node= fs= foo=
1494 while read point node fs foo ; do
1495 [[ " cd9660 iso9660 udf " != *" ${fs} "* ]] && \
1496 ! [[ ${fs} == "subfs" && ",${opts}," == *",fs=cdfss,"* ]] \
1497 && continue
1498 point=${point//\040/ }
1499 [[ ! -d ${point}/${dir} ]] && continue
1500 [[ -z $(find "${point}/${dir}" -maxdepth 1 -iname "${file}") ]] && continue
1501 export CDROM_ROOT=${point}
1502 export CDROM_SET=${i}
1503 export CDROM_MATCH=${cdset[${i}]}
1504 return
1505 done <<< "$(get_mounts)"
1506
1507 ((++i))
1508 done
1509
1510 echo
1511 if [[ ${showedmsg} -eq 0 ]] ; then
1512 if [[ ${CDROM_TOTAL_CDS} -eq 1 ]] ; then
1513 if [[ -z ${CDROM_NAME} ]] ; then
1514 einfo "Please insert+mount the cdrom for ${PN} now !"
1515 else
1516 einfo "Please insert+mount the ${CDROM_NAME} cdrom now !"
1517 fi
1518 else
1519 if [[ -z ${CDROM_NAME_1} ]] ; then
1520 einfo "Please insert+mount cd #${CDROM_CURRENT_CD} for ${PN} now !"
1521 else
1522 local var="CDROM_NAME_${CDROM_CURRENT_CD}"
1523 einfo "Please insert+mount the ${!var} cdrom now !"
1524 fi
1525 fi
1526 showedmsg=1
1527 fi
1528 einfo "Press return to scan for the cd again"
1529 einfo "or hit CTRL+C to abort the emerge."
1530 echo
1531 if [[ ${showjolietmsg} -eq 0 ]] ; then
1532 showjolietmsg=1
1533 else
1534 ewarn "If you are having trouble with the detection"
1535 ewarn "of your CD, it is possible that you do not have"
1536 ewarn "Joliet support enabled in your kernel. Please"
1537 ewarn "check that CONFIG_JOLIET is enabled in your kernel."
1538 ebeep 5
1539 fi
1540 read || die "something is screwed with your system"
1541 done
1542 }
1543
1544 # @FUNCTION: strip-linguas
1545 # @USAGE: [<allow LINGUAS>|<-i|-u> <directories of .po files>]
1546 # @DESCRIPTION:
1547 # Make sure that LINGUAS only contains languages that
1548 # a package can support. The first form allows you to
1549 # specify a list of LINGUAS. The -i builds a list of po
1550 # files found in all the directories and uses the
1551 # intersection of the lists. The -u builds a list of po
1552 # files found in all the directories and uses the union
1553 # of the lists.
1554 strip-linguas() {
1555 local ls newls nols
1556 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then
1557 local op=$1; shift
1558 ls=$(find "$1" -name '*.po' -exec basename {} .po \;); shift
1559 local d f
1560 for d in "$@" ; do
1561 if [[ ${op} == "-u" ]] ; then
1562 newls=${ls}
1563 else
1564 newls=""
1565 fi
1566 for f in $(find "$d" -name '*.po' -exec basename {} .po \;) ; do
1567 if [[ ${op} == "-i" ]] ; then
1568 hasq ${f} ${ls} && newls="${newls} ${f}"
1569 else
1570 hasq ${f} ${ls} || newls="${newls} ${f}"
1571 fi
1572 done
1573 ls=${newls}
1574 done
1575 else
1576 ls="$@"
1577 fi
1578
1579 nols=""
1580 newls=""
1581 for f in ${LINGUAS} ; do
1582 if hasq ${f} ${ls} ; then
1583 newls="${newls} ${f}"
1584 else
1585 nols="${nols} ${f}"
1586 fi
1587 done
1588 [[ -n ${nols} ]] \
1589 && ewarn "Sorry, but ${PN} does not support the LINGUAs:" ${nols}
1590 export LINGUAS=${newls:1}
1591 }
1592
1593 # @FUNCTION: preserve_old_lib
1594 # @USAGE: <libs to preserve> [more libs]
1595 # @DESCRIPTION:
1596 # These functions are useful when a lib in your package changes ABI SONAME.
1597 # An example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0
1598 # would break packages that link against it. Most people get around this
1599 # by using the portage SLOT mechanism, but that is not always a relevant
1600 # solution, so instead you can call this from pkg_preinst. See also the
1601 # preserve_old_lib_notify function.
1602 preserve_old_lib() {
1603 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then
1604 eerror "preserve_old_lib() must be called from pkg_preinst() only"
1605 die "Invalid preserve_old_lib() usage"
1606 fi
1607 [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]"
1608
1609 # let portage worry about it
1610 has preserve-libs ${FEATURES} && return 0
1611
1612 local lib dir
1613 for lib in "$@" ; do
1614 [[ -e ${ROOT}/${lib} ]] || continue
1615 dir=${lib%/*}
1616 dodir ${dir} || die "dodir ${dir} failed"
1617 cp "${ROOT}"/${lib} "${D}"/${lib} || die "cp ${lib} failed"
1618 touch "${D}"/${lib}
1619 done
1620 }
1621
1622 # @FUNCTION: preserve_old_lib_notify
1623 # @USAGE: <libs to notify> [more libs]
1624 # @DESCRIPTION:
1625 # Spit helpful messages about the libraries preserved by preserve_old_lib.
1626 preserve_old_lib_notify() {
1627 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then
1628 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only"
1629 die "Invalid preserve_old_lib_notify() usage"
1630 fi
1631
1632 # let portage worry about it
1633 has preserve-libs ${FEATURES} && return 0
1634
1635 local lib notice=0
1636 for lib in "$@" ; do
1637 [[ -e ${ROOT}/${lib} ]] || continue
1638 if [[ ${notice} -eq 0 ]] ; then
1639 notice=1
1640 ewarn "Old versions of installed libraries were detected on your system."
1641 ewarn "In order to avoid breaking packages that depend on these old libs,"
1642 ewarn "the libraries are not being removed. You need to run revdep-rebuild"
1643 ewarn "in order to remove these old dependencies. If you do not have this"
1644 ewarn "helper program, simply emerge the 'gentoolkit' package."
1645 ewarn
1646 fi
1647 ewarn " # revdep-rebuild --library ${lib##*/}"
1648 done
1649 if [[ ${notice} -eq 1 ]] ; then
1650 ewarn
1651 ewarn "Once you've finished running revdep-rebuild, it should be safe to"
1652 ewarn "delete the old libraries. Here is a copy & paste for the lazy:"
1653 for lib in "$@" ; do
1654 ewarn " # rm '${lib}'"
1655 done
1656 fi
1657 }
1658
1659 # @FUNCTION: built_with_use
1660 # @USAGE: [--hidden] [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags>
1661 # @DESCRIPTION:
1662 # A temporary hack until portage properly supports DEPENDing on USE
1663 # flags being enabled in packages. This will check to see if the specified
1664 # DEPEND atom was built with the specified list of USE flags. The
1665 # --missing option controls the behavior if called on a package that does
1666 # not actually support the defined USE flags (aka listed in IUSE).
1667 # The default is to abort (call die). The -a and -o flags control
1668 # the requirements of the USE flags. They correspond to "and" and "or"
1669 # logic. So the -a flag means all listed USE flags must be enabled
1670 # while the -o flag means at least one of the listed fIUSE flags must be
1671 # enabled. The --hidden option is really for internal use only as it
1672 # means the USE flag we're checking is hidden expanded, so it won't be found
1673 # in IUSE like normal USE flags.
1674 #
1675 # Remember that this function isn't terribly intelligent so order of optional
1676 # flags matter.
1677 built_with_use() {
1678 local hidden="no"
1679 if [[ $1 == "--hidden" ]] ; then
1680 hidden="yes"
1681 shift
1682 fi
1683
1684 local missing_action="die"
1685 if [[ $1 == "--missing" ]] ; then
1686 missing_action=$2
1687 shift ; shift
1688 case ${missing_action} in
1689 true|false|die) ;;
1690 *) die "unknown action '${missing_action}'";;
1691 esac
1692 fi
1693
1694 local opt=$1
1695 [[ ${opt:0:1} = "-" ]] && shift || opt="-a"
1696
1697 local PKG=$(best_version $1)
1698 [[ -z ${PKG} ]] && die "Unable to resolve $1 to an installed package"
1699 shift
1700
1701 local USEFILE=${ROOT}/var/db/pkg/${PKG}/USE
1702 local IUSEFILE=${ROOT}/var/db/pkg/${PKG}/IUSE
1703
1704 # if the IUSE file doesn't exist, the read will error out, we need to handle
1705 # this gracefully
1706 if [[ ! -e ${USEFILE} ]] || [[ ! -e ${IUSEFILE} && ${hidden} == "no" ]] ; then
1707 case ${missing_action} in
1708 true) return 0;;
1709 false) return 1;;
1710 die) die "Unable to determine what USE flags $PKG was built with";;
1711 esac
1712 fi
1713
1714 if [[ ${hidden} == "no" ]] ; then
1715 local IUSE_BUILT=$(<${IUSEFILE})
1716 # Don't check USE_EXPAND #147237
1717 local expand
1718 for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do
1719 if [[ $1 == ${expand}_* ]] ; then
1720 expand=""
1721 break
1722 fi
1723 done
1724 if [[ -n ${expand} ]] ; then
1725 if ! has $1 ${IUSE_BUILT} ; then
1726 case ${missing_action} in
1727 true) return 0;;
1728 false) return 1;;
1729 die) die "$PKG does not actually support the $1 USE flag!";;
1730 esac
1731 fi
1732 fi
1733 fi
1734
1735 local USE_BUILT=$(<${USEFILE})
1736 while [[ $# -gt 0 ]] ; do
1737 if [[ ${opt} = "-o" ]] ; then
1738 has $1 ${USE_BUILT} && return 0
1739 else
1740 has $1 ${USE_BUILT} || return 1
1741 fi
1742 shift
1743 done
1744 [[ ${opt} = "-a" ]]
1745 }
1746
1747 # @FUNCTION: epunt_cxx
1748 # @USAGE: [dir to scan]
1749 # @DESCRIPTION:
1750 # Many configure scripts wrongly bail when a C++ compiler could not be
1751 # detected. If dir is not specified, then it defaults to ${S}.
1752 #
1753 # http://bugs.gentoo.org/73450
1754 epunt_cxx() {
1755 local dir=$1
1756 [[ -z ${dir} ]] && dir=${S}
1757 ebegin "Removing useless C++ checks"
1758 local f
1759 find "${dir}" -name configure | while read f ; do
1760 patch --no-backup-if-mismatch -p0 "${f}" "${PORTDIR}/eclass/ELT-patches/nocxx/nocxx.patch" > /dev/null
1761 done
1762 eend 0
1763 }
1764
1765 # @FUNCTION: make_wrapper
1766 # @USAGE: <wrapper> <target> [chdir] [libpaths] [installpath]
1767 # @DESCRIPTION:
1768 # Create a shell wrapper script named wrapper in installpath
1769 # (defaults to the bindir) to execute target (default of wrapper) by
1770 # first optionally setting LD_LIBRARY_PATH to the colon-delimited
1771 # libpaths followed by optionally changing directory to chdir.
1772 make_wrapper() {
1773 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5
1774 local tmpwrapper=$(emktemp)
1775 # We don't want to quote ${bin} so that people can pass complex
1776 # things as $bin ... "./someprog --args"
1777 cat << EOF > "${tmpwrapper}"
1778 #!/bin/sh
1779 cd "${chdir:-.}"
1780 if [ -n "${libdir}" ] ; then
1781 if [ "\${LD_LIBRARY_PATH+set}" = "set" ] ; then
1782 export LD_LIBRARY_PATH="\${LD_LIBRARY_PATH}:${libdir}"
1783 else
1784 export LD_LIBRARY_PATH="${libdir}"
1785 fi
1786 fi
1787 exec ${bin} "\$@"
1788 EOF
1789 chmod go+rx "${tmpwrapper}"
1790 if [[ -n ${path} ]] ; then
1791 (
1792 exeinto "${path}"
1793 newexe "${tmpwrapper}" "${wrapper}"
1794 ) || die
1795 else
1796 newbin "${tmpwrapper}" "${wrapper}" || die
1797 fi
1798 }

  ViewVC Help
Powered by ViewVC 1.1.20