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

Contents of /eclass/unpacker.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.12 - (hide annotations) (download)
Sat Mar 23 21:18:25 2013 UTC (20 months, 3 weeks ago) by hasufell
Branch: MAIN
Changes since 1.11: +23 -2 lines
add unpack_zip function to unpacker.eclass wrt #462612

1 hasufell 1.12 # Copyright 1999-2013 Gentoo Foundation
2 vapier 1.1 # Distributed under the terms of the GNU General Public License v2
3 hasufell 1.12 # $Header: /var/cvsroot/gentoo-x86/eclass/unpacker.eclass,v 1.11 2013/03/23 19:35:59 vapier Exp $
4 vapier 1.1
5     # @ECLASS: unpacker.eclass
6     # @MAINTAINER:
7     # base-system@gentoo.org
8     # @BLURB: helpers for extraneous file formats and consistent behavior across EAPIs
9     # @DESCRIPTION:
10     # Some extraneous file formats are not part of PMS, or are only in certain
11     # EAPIs. Rather than worrying about that, support the crazy cruft here
12     # and for all EAPI versions.
13    
14     # Possible todos:
15     # - merge rpm unpacking
16     # - support partial unpacks?
17    
18     if [[ ${___ECLASS_ONCE_UNPACKER} != "recur -_+^+_- spank" ]] ; then
19     ___ECLASS_ONCE_UNPACKER="recur -_+^+_- spank"
20    
21     # @ECLASS-VARIABLE: UNPACKER_BZ2
22     # @DEFAULT_UNSET
23     # @DESCRIPTION:
24     # Utility to use to decompress bzip2 files. Will dynamically pick between
25     # `pbzip2` and `bzip2`. Make sure your choice accepts the "-c" option.
26     # Note: this is meant for users to set, not ebuilds.
27    
28     # for internal use only (unpack_pdv and unpack_makeself)
29     find_unpackable_file() {
30     local src=$1
31     if [[ -z ${src} ]] ; then
32     src=${DISTDIR}/${A}
33     else
34     if [[ ${src} == ./* ]] ; then
35     : # already what we want
36     elif [[ -e ${DISTDIR}/${src} ]] ; then
37     src=${DISTDIR}/${src}
38     elif [[ -e ${PWD}/${src} ]] ; then
39     src=${PWD}/${src}
40     elif [[ -e ${src} ]] ; then
41     src=${src}
42     fi
43     fi
44     [[ ! -e ${src} ]] && return 1
45     echo "${src}"
46     }
47    
48     unpack_banner() {
49     echo ">>> Unpacking ${1##*/} to ${PWD}"
50     }
51    
52     # @FUNCTION: unpack_pdv
53     # @USAGE: <file to unpack> <size of off_t>
54     # @DESCRIPTION:
55     # Unpack those pesky pdv generated files ...
56     # They're self-unpacking programs with the binary package stuffed in
57     # the middle of the archive. Valve seems to use it a lot ... too bad
58     # it seems to like to segfault a lot :(. So lets take it apart ourselves.
59     #
60     # You have to specify the off_t size ... I have no idea how to extract that
61     # information out of the binary executable myself. Basically you pass in
62     # the size of the off_t type (in bytes) on the machine that built the pdv
63     # archive.
64     #
65     # One way to determine this is by running the following commands:
66     #
67     # @CODE
68     # strings <pdv archive> | grep lseek
69     # strace -elseek <pdv archive>
70     # @CODE
71     #
72     # Basically look for the first lseek command (we do the strings/grep because
73     # sometimes the function call is _llseek or something) and steal the 2nd
74     # parameter. Here is an example:
75     #
76     # @CODE
77     # vapier@vapier 0 pdv_unpack # strings hldsupdatetool.bin | grep lseek
78     # lseek
79     # vapier@vapier 0 pdv_unpack # strace -elseek ./hldsupdatetool.bin
80     # lseek(3, -4, SEEK_END) = 2981250
81     # @CODE
82     #
83     # Thus we would pass in the value of '4' as the second parameter.
84     unpack_pdv() {
85     local src=$(find_unpackable_file "$1")
86     local sizeoff_t=$2
87    
88     [[ -z ${src} ]] && die "Could not locate source for '$1'"
89     [[ -z ${sizeoff_t} ]] && die "No idea what off_t size was used for this pdv :("
90    
91     unpack_banner "${src}"
92    
93     local metaskip=$(tail -c ${sizeoff_t} "${src}" | hexdump -e \"%i\")
94     local tailskip=$(tail -c $((${sizeoff_t}*2)) "${src}" | head -c ${sizeoff_t} | hexdump -e \"%i\")
95    
96     # grab metadata for debug reasons
97 vapier 1.2 local metafile="${T}/${FUNCNAME}.meta"
98 vapier 1.1 tail -c +$((${metaskip}+1)) "${src}" > "${metafile}"
99    
100     # rip out the final file name from the metadata
101     local datafile=$(tail -c +$((${metaskip}+1)) "${src}" | strings | head -n 1)
102     datafile=$(basename "${datafile}")
103    
104     # now lets uncompress/untar the file if need be
105 vapier 1.2 local tmpfile="${T}/${FUNCNAME}"
106     tail -c +$((${tailskip}+1)) ${src} 2>/dev/null | head -c 512 > "${tmpfile}"
107 vapier 1.1
108     local iscompressed=$(file -b "${tmpfile}")
109     if [[ ${iscompressed:0:8} == "compress" ]] ; then
110     iscompressed=1
111 vapier 1.2 mv "${tmpfile}"{,.Z}
112     gunzip "${tmpfile}"
113 vapier 1.1 else
114     iscompressed=0
115     fi
116     local istar=$(file -b "${tmpfile}")
117     if [[ ${istar:0:9} == "POSIX tar" ]] ; then
118     istar=1
119     else
120     istar=0
121     fi
122    
123     #for some reason gzip dies with this ... dd cant provide buffer fast enough ?
124     #dd if=${src} ibs=${metaskip} count=1 \
125     # | dd ibs=${tailskip} skip=1 \
126     # | gzip -dc \
127     # > ${datafile}
128     if [ ${iscompressed} -eq 1 ] ; then
129     if [ ${istar} -eq 1 ] ; then
130 vapier 1.2 tail -c +$((${tailskip}+1)) "${src}" 2>/dev/null \
131 vapier 1.1 | head -c $((${metaskip}-${tailskip})) \
132     | tar -xzf -
133     else
134 vapier 1.2 tail -c +$((${tailskip}+1)) "${src}" 2>/dev/null \
135 vapier 1.1 | head -c $((${metaskip}-${tailskip})) \
136     | gzip -dc \
137     > ${datafile}
138     fi
139     else
140     if [ ${istar} -eq 1 ] ; then
141 vapier 1.2 tail -c +$((${tailskip}+1)) "${src}" 2>/dev/null \
142 vapier 1.1 | head -c $((${metaskip}-${tailskip})) \
143     | tar --no-same-owner -xf -
144     else
145 vapier 1.2 tail -c +$((${tailskip}+1)) "${src}" 2>/dev/null \
146 vapier 1.1 | head -c $((${metaskip}-${tailskip})) \
147     > ${datafile}
148     fi
149     fi
150     true
151     #[ -s "${datafile}" ] || die "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
152     #assert "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
153     }
154    
155     # @FUNCTION: unpack_makeself
156     # @USAGE: [file to unpack] [offset] [tail|dd]
157     # @DESCRIPTION:
158     # Unpack those pesky makeself generated files ...
159     # They're shell scripts with the binary package tagged onto
160     # the end of the archive. Loki utilized the format as does
161     # many other game companies.
162     #
163     # If the file is not specified, then ${A} is used. If the
164     # offset is not specified then we will attempt to extract
165     # the proper offset from the script itself.
166     unpack_makeself() {
167     local src_input=${1:-${A}}
168     local src=$(find_unpackable_file "${src_input}")
169     local skip=$2
170     local exe=$3
171    
172     [[ -z ${src} ]] && die "Could not locate source for '${src_input}'"
173    
174     unpack_banner "${src}"
175    
176     if [[ -z ${skip} ]] ; then
177     local ver=$(grep -m1 -a '#.*Makeself' "${src}" | awk '{print $NF}')
178     local skip=0
179     exe=tail
180     case ${ver} in
181     1.5.*|1.6.0-nv) # tested 1.5.{3,4,5} ... guessing 1.5.x series is same
182     skip=$(grep -a ^skip= "${src}" | cut -d= -f2)
183     ;;
184     2.0|2.0.1)
185     skip=$(grep -a ^$'\t'tail "${src}" | awk '{print $2}' | cut -b2-)
186     ;;
187     2.1.1)
188     skip=$(grep -a ^offset= "${src}" | awk '{print $2}' | cut -b2-)
189     (( skip++ ))
190     ;;
191     2.1.2)
192     skip=$(grep -a ^offset= "${src}" | awk '{print $3}' | head -n 1)
193     (( skip++ ))
194     ;;
195     2.1.3)
196     skip=`grep -a ^offset= "${src}" | awk '{print $3}'`
197     (( skip++ ))
198     ;;
199 vapier 1.4 2.1.4|2.1.5|2.1.6)
200 vapier 1.1 skip=$(grep -a offset=.*head.*wc "${src}" | awk '{print $3}' | head -n 1)
201     skip=$(head -n ${skip} "${src}" | wc -c)
202     exe="dd"
203     ;;
204     *)
205     eerror "I'm sorry, but I was unable to support the Makeself file."
206     eerror "The version I detected was '${ver}'."
207     eerror "Please file a bug about the file ${src##*/} at"
208     eerror "http://bugs.gentoo.org/ so that support can be added."
209     die "makeself version '${ver}' not supported"
210     ;;
211     esac
212     debug-print "Detected Makeself version ${ver} ... using ${skip} as offset"
213     fi
214     case ${exe} in
215     tail) exe="tail -n +${skip} '${src}'";;
216     dd) exe="dd ibs=${skip} skip=1 if='${src}'";;
217     *) die "makeself cant handle exe '${exe}'"
218     esac
219    
220     # lets grab the first few bytes of the file to figure out what kind of archive it is
221 vapier 1.2 local filetype tmpfile="${T}/${FUNCNAME}"
222 vapier 1.1 eval ${exe} 2>/dev/null | head -c 512 > "${tmpfile}"
223     filetype=$(file -b "${tmpfile}") || die
224     case ${filetype} in
225     *tar\ archive*)
226     eval ${exe} | tar --no-same-owner -xf -
227     ;;
228     bzip2*)
229     eval ${exe} | bzip2 -dc | tar --no-same-owner -xf -
230     ;;
231     gzip*)
232     eval ${exe} | tar --no-same-owner -xzf -
233     ;;
234     compress*)
235     eval ${exe} | gunzip | tar --no-same-owner -xf -
236     ;;
237     *)
238     eerror "Unknown filetype \"${filetype}\" ?"
239     false
240     ;;
241     esac
242     assert "failure unpacking (${filetype}) makeself ${src##*/} ('${ver}' +${skip})"
243     }
244    
245     # @FUNCTION: unpack_deb
246     # @USAGE: <one deb to unpack>
247     # @DESCRIPTION:
248     # Unpack a Debian .deb archive in style.
249     unpack_deb() {
250     [[ $# -eq 1 ]] || die "Usage: ${FUNCNAME} <file>"
251    
252     local deb=$(find_unpackable_file "$1")
253    
254     unpack_banner "${deb}"
255    
256 vapier 1.7 # on AIX ar doesn't work out as their ar used a different format
257     # from what GNU ar (and thus what .deb files) produce
258     if [[ -n ${EPREFIX} ]] ; then
259     {
260     read # global header
261     [[ ${REPLY} = "!<arch>" ]] || die "${deb} does not seem to be a deb archive"
262     local f timestamp uid gid mode size magic
263     while read f timestamp uid gid mode size magic ; do
264     [[ -n ${f} && -n ${size} ]] || continue # ignore empty lines
265     if [[ ${f} = "data.tar"* ]] ; then
266     head -c "${size}" > "${f}"
267     else
268     head -c "${size}" > /dev/null # trash it
269     fi
270     done
271     } < "${deb}"
272     else
273     ar x "${deb}"
274     fi
275    
276     unpacker ./data.tar*
277 vapier 1.11
278     # Clean things up #458658. No one seems to actually care about
279     # these, so wait until someone requests to do something else ...
280     rm -f debian-binary {control,data}.tar*
281 vapier 1.1 }
282    
283 ottxor 1.10 # @FUNCTION: unpack_cpio
284     # @USAGE: <one cpio to unpack>
285     # @DESCRIPTION:
286     # Unpack a cpio archive, file "-" means stdin.
287     unpack_cpio() {
288     [[ $# -eq 1 ]] || die "Usage: ${FUNCNAME} <file>"
289    
290     # needed as cpio always reads from stdin
291     local cpio_cmd=( cpio --make-directories --extract --preserve-modification-time )
292     if [[ $1 == "-" ]] ; then
293     unpack_banner "stdin"
294     "${cpio_cmd[@]}"
295     else
296     local cpio=$(find_unpackable_file "$1")
297     unpack_banner "${cpio}"
298     "${cpio_cmd[@]}" <"${cpio}"
299     fi
300     }
301    
302 hasufell 1.12 # @FUNCTION: unpack_zip
303     # @USAGE: <zip file>
304     # @DESCRIPTION:
305     # Unpack zip archives.
306     # This function ignores all non-fatal errors (i.e. warnings).
307     # That is useful for zip archives with extra crap attached
308     # (e.g. self-extracting archives).
309     unpack_zip() {
310     [[ $# -eq 1 ]] || die "Usage: ${FUNCNAME} <file>"
311    
312     local zip=$(find_unpackable_file "$1")
313     unpack_banner "${zip}"
314     unzip -qo "${zip}"
315    
316     [[ $? -le 1 ]] || die "unpacking ${zip} failed (arch=unpack_zip)"
317     }
318    
319 vapier 1.1 # @FUNCTION: _unpacker
320     # @USAGE: <one archive to unpack>
321     # @INTERNAL
322     # @DESCRIPTION:
323     # Unpack the specified archive. We only operate on one archive here
324     # to keep down on the looping logic (that is handled by `unpacker`).
325     _unpacker() {
326     [[ $# -eq 1 ]] || die "Usage: ${FUNCNAME} <file>"
327    
328     local a=$1
329     local m=$(echo "${a}" | tr '[:upper:]' '[:lower:]')
330     a=$(find_unpackable_file "${a}")
331    
332     # first figure out the decompression method
333     case ${m} in
334     *.bz2|*.tbz|*.tbz2)
335 vapier 1.8 local bzcmd=${PORTAGE_BZIP2_COMMAND:-$(type -P pbzip2 || type -P bzip2)}
336     local bzuncmd=${PORTAGE_BUNZIP2_COMMAND:-${bzcmd} -d}
337 vapier 1.1 : ${UNPACKER_BZ2:=${bzuncmd}}
338     comp="${UNPACKER_BZ2} -c"
339     ;;
340     *.z|*.gz|*.tgz)
341     comp="gzip -dc" ;;
342     *.lzma|*.xz|*.txz)
343     comp="xz -dc" ;;
344     *) comp="" ;;
345     esac
346    
347     # then figure out if there are any archiving aspects
348 vapier 1.5 arch=""
349 vapier 1.1 case ${m} in
350     *.tgz|*.tbz|*.tbz2|*.txz|*.tar.*|*.tar)
351     arch="tar --no-same-owner -xof" ;;
352 ottxor 1.10 *.cpio.*|*.cpio)
353     arch="unpack_cpio" ;;
354 vapier 1.1 *.deb)
355     arch="unpack_deb" ;;
356     *.run)
357     arch="unpack_makeself" ;;
358 vapier 1.9 *.sh)
359     # Not all shell scripts are makeself
360     if head -n 30 "${a}" | grep -qs '#.*Makeself' ; then
361     arch="unpack_makeself"
362     fi
363     ;;
364 vapier 1.5 *.bin)
365     # Makeself archives can be annoyingly named
366     if head -c 100 "${a}" | grep -qs '#.*Makeself' ; then
367     arch="unpack_makeself"
368     fi
369     ;;
370 hasufell 1.12 *.zip)
371     arch="unpack_zip" ;;
372 vapier 1.1 esac
373    
374     # finally do the unpack
375     if [[ -z ${arch}${comp} ]] ; then
376 vapier 1.3 unpack "$1"
377 vapier 1.1 return $?
378     fi
379    
380     [[ ${arch} != unpack_* ]] && unpack_banner "${a}"
381    
382     if [[ -z ${arch} ]] ; then
383 vapier 1.6 # Need to decompress the file into $PWD #408801
384     local _a=${a%.*}
385     ${comp} "${a}" > "${_a##*/}"
386 vapier 1.1 elif [[ -z ${comp} ]] ; then
387     ${arch} "${a}"
388     else
389     ${comp} "${a}" | ${arch} -
390     fi
391    
392     assert "unpacking ${a} failed (comp=${comp} arch=${arch})"
393     }
394    
395     # @FUNCTION: unpacker
396     # @USAGE: [archives to unpack]
397     # @DESCRIPTION:
398     # This works in the same way that `unpack` does. If you don't specify
399     # any files, it will default to ${A}.
400     unpacker() {
401     local a
402     [[ $# -eq 0 ]] && set -- ${A}
403     for a ; do _unpacker "${a}" ; done
404     }
405    
406     # @FUNCTION: unpacker_src_unpack
407     # @DESCRIPTION:
408     # Run `unpacker` to unpack all our stuff.
409     unpacker_src_unpack() {
410     unpacker
411     }
412    
413     # @FUNCTION: unpacker_src_uri_depends
414     # @USAGE: [archives that we will unpack]
415     # @RETURN: Dependencies needed to unpack all the archives
416     # @DESCRIPTION:
417     # Walk all the specified files (defaults to $SRC_URI) and figure out the
418     # dependencies that are needed to unpack things.
419     #
420     # Note: USE flags are not yet handled.
421     unpacker_src_uri_depends() {
422     local uri deps d
423    
424     [[ $# -eq 0 ]] && set -- ${SRC_URI}
425    
426     for uri in "$@" ; do
427     case ${uri} in
428 ottxor 1.10 *.cpio.*|*.cpio)
429     d="app-arch/cpio" ;;
430 vapier 1.1 *.rar|*.RAR)
431     d="app-arch/unrar" ;;
432     *.7z)
433     d="app-arch/p7zip" ;;
434     *.xz)
435     d="app-arch/xz-utils" ;;
436 hasufell 1.12 *.zip)
437     d="app-arch/unzip" ;;
438 vapier 1.1 esac
439     deps+=" ${d}"
440     done
441    
442     echo "${deps}"
443     }
444    
445     EXPORT_FUNCTIONS src_unpack
446    
447     fi

  ViewVC Help
Powered by ViewVC 1.1.20