source: rtems-source-builder/source-builder/sb/download.py @ 0a0d1c8

Last change on this file since 0a0d1c8 was 0a0d1c8, checked in by Sebastian Huber <sebastian.huber@…>, on Jun 8, 2017 at 5:21:07 AM

sb: Restrict file name length

  • Property mode set to 100644
File size: 23.6 KB
Line 
1#
2# RTEMS Tools Project (http://www.rtems.org/)
3# Copyright 2010-2016 Chris Johns (chrisj@rtems.org)
4# All rights reserved.
5#
6# This file is part of the RTEMS Tools package in 'rtems-tools'.
7#
8# Permission to use, copy, modify, and/or distribute this software for any
9# purpose with or without fee is hereby granted, provided that the above
10# copyright notice and this permission notice appear in all copies.
11#
12# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19
20#
21# This code builds a package given a config file. It only builds to be
22# installed not to be package unless you run a packager around this.
23#
24
25from __future__ import print_function
26
27import hashlib
28import os
29import re
30import stat
31import sys
32try:
33    import urllib.request as urllib_request
34    import urllib.parse as urllib_parse
35except ImportError:
36    import urllib2 as urllib_request
37    import urlparse as urllib_parse
38
39import cvs
40import error
41import git
42import log
43import path
44import sources
45import version
46
47def _do_download(opts):
48    download = True
49    if opts.dry_run():
50        download = False
51        wa = opts.with_arg('download')
52        if wa is not None:
53            if wa[0] == 'with_download' and wa[1] == 'yes':
54                download = True
55    return download
56
57def _humanize_bytes(bytes, precision = 1):
58    abbrevs = (
59        (1 << 50, 'PB'),
60        (1 << 40, 'TB'),
61        (1 << 30, 'GB'),
62        (1 << 20, 'MB'),
63        (1 << 10, 'kB'),
64        (1, ' bytes')
65    )
66    if bytes == 1:
67        return '1 byte'
68    for factor, suffix in abbrevs:
69        if bytes >= factor:
70            break
71    return '%.*f%s' % (precision, float(bytes) / factor, suffix)
72
73def _sensible_url(url, used = 0):
74    space = 200
75    if len(url) > space:
76        size = int(space - 14)
77        url = url[:size] + '...<see log>'
78    return url
79
80def _hash_check(file_, absfile, macros, remove = True):
81    failed = False
82    hash = sources.get_hash(file_.lower(), macros)
83    if hash is not None:
84        hash = hash.split()
85        if len(hash) != 2:
86            raise error.internal('invalid hash format: %s' % (file_))
87        try:
88            hashlib_algorithms = hashlib.algorithms
89        except:
90            hashlib_algorithms = ['md5', 'sha1', 'sha224', 'sha256', 'sha384', 'sha512']
91        if hash[0] not in hashlib_algorithms:
92            raise error.general('invalid hash algorithm for %s: %s' % (file_, hash[0]))
93        hasher = None
94        _in = None
95        try:
96            hasher = hashlib.new(hash[0])
97            _in = open(path.host(absfile), 'rb')
98            hasher.update(_in.read())
99        except IOError as err:
100            log.notice('hash: %s: read error: %s' % (file_, str(err)))
101            failed = True
102        except:
103            msg = 'hash: %s: error' % (file_)
104            log.stderr(msg)
105            log.notice(msg)
106            if _in is not None:
107                _in.close()
108            raise
109        if _in is not None:
110            _in.close()
111        log.output('checksums: %s: %s => %s' % (file_, hasher.hexdigest(), hash[1]))
112        if hasher.hexdigest() != hash[1]:
113            log.warning('checksum error: %s' % (file_))
114            failed = True
115        if failed and remove:
116            log.warning('removing: %s' % (file_))
117            if path.exists(absfile):
118                try:
119                    os.remove(path.host(absfile))
120                except IOError as err:
121                    raise error.general('hash: %s: remove: %s' % (absfile, str(err)))
122                except:
123                    raise error.general('hash: %s: remove error' % (file_))
124        if hasher is not None:
125            del hasher
126    else:
127        if version.released():
128            raise error.general('%s: no hash found in released RSB' % (file_))
129        log.warning('%s: no hash found' % (file_))
130    return not failed
131
132def _local_path(source, pathkey, config):
133    for p in config.define(pathkey).split(':'):
134        local_prefix = path.abspath(p)
135        local = path.join(local_prefix, source['file'])
136        if source['local'] is None:
137            source['local_prefix'] = local_prefix
138            source['local'] = local
139        if path.exists(local):
140            source['local_prefix'] = local_prefix
141            source['local'] = local
142            _hash_check(source['file'], local, config.macros)
143            break
144
145def _http_parser(source, pathkey, config, opts):
146    #
147    # If the file has not been overrided attempt to recover a possible file name.
148    #
149    if 'file-override' not in source['options']:
150        #
151        # Hack for gitweb.cgi patch downloads. We rewrite the various fields.
152        #
153        if 'gitweb.cgi' in source['url']:
154            url = source['url']
155            if '?' not in url:
156                raise error.general('invalid gitweb.cgi request: %s' % (url))
157            req = url.split('?')[1]
158            if len(req) == 0:
159                raise error.general('invalid gitweb.cgi request: %s' % (url))
160            #
161            # The gitweb.cgi request should have:
162            #    p=<what>
163            #    a=patch
164            #    h=<hash>
165            # so extract the p and h parts to make the local name.
166            #
167            p = None
168            a = None
169            h = None
170            for r in req.split(';'):
171                if '=' not in r:
172                    raise error.general('invalid gitweb.cgi path: %s' % (url))
173                rs = r.split('=')
174                if rs[0] == 'p':
175                    p = rs[1].replace('.', '-')
176                elif rs[0] == 'a':
177                    a = rs[1]
178                elif rs[0] == 'h':
179                    h = rs[1]
180            if p is None or h is None:
181                raise error.general('gitweb.cgi path missing p or h: %s' % (url))
182            source['file'] = '%s-%s.patch' % (p, h)
183        #
184        # Wipe out everything special in the file name.
185        #
186        source['file'] = re.sub(r'[^a-zA-Z0-9.\-]+', '-', source['file'])
187        max_file_len = 127
188        if len(source['file']) > max_file_len:
189            raise error.general('file name length is greater than %i (maybe use --rsb-file=FILE option): %s' % \
190                                (max_file_len, source['file']))
191    #
192    # Check local path
193    #
194    _local_path(source, pathkey, config)
195    #
196    # Is the file compressed ?
197    #
198    esl = source['ext'].split('.')
199    if esl[-1:][0] == 'gz':
200        source['compressed-type'] = 'gzip'
201        source['compressed'] = '%{__gzip} -dc'
202    elif esl[-1:][0] == 'bz2':
203        source['compressed-type'] = 'bzip2'
204        source['compressed'] = '%{__bzip2} -dc'
205    elif esl[-1:][0] == 'zip':
206        source['compressed-type'] = 'zip'
207        source['compressed'] = '%{__unzip} -u'
208    elif esl[-1:][0] == 'xz':
209        source['compressed-type'] = 'xz'
210        source['compressed'] = '%{__xz} -dc'
211
212def _patchworks_parser(source, pathkey, config, opts):
213    #
214    # Check local path
215    #
216    _local_path(source, pathkey, config)
217    source['url'] = 'http%s' % (source['path'][2:])
218
219def _git_parser(source, pathkey, config, opts):
220    #
221    # Check local path
222    #
223    _local_path(source, pathkey, config)
224    #
225    # Symlink.
226    #
227    us = source['url'].split('?')
228    source['path'] = path.dirname(us[0])
229    source['file'] = path.basename(us[0])
230    source['name'], source['ext'] = path.splitext(source['file'])
231    if len(us) > 1:
232        source['args'] = us[1:]
233    source['local'] = \
234        path.join(source['local_prefix'], 'git', source['file'])
235    source['symlink'] = source['local']
236
237def _cvs_parser(source, pathkey, config, opts):
238    #
239    # Check local path
240    #
241    _local_path(source, pathkey, config)
242    #
243    # Symlink.
244    #
245    if not source['url'].startswith('cvs://'):
246        raise error.general('invalid cvs path: %s' % (source['url']))
247    us = source['url'].split('?')
248    try:
249        url = us[0]
250        source['file'] = url[url[6:].index(':') + 7:]
251        source['cvsroot'] = ':%s:' % (url[6:url[6:].index('/') + 6:])
252    except:
253        raise error.general('invalid cvs path: %s' % (source['url']))
254    for a in us[1:]:
255        _as = a.split('=')
256        if _as[0] == 'module':
257            if len(_as) != 2:
258                raise error.general('invalid cvs module: %s' % (a))
259            source['module'] = _as[1]
260        elif _as[0] == 'src-prefix':
261            if len(_as) != 2:
262                raise error.general('invalid cvs src-prefix: %s' % (a))
263            source['src_prefix'] = _as[1]
264        elif _as[0] == 'tag':
265            if len(_as) != 2:
266                raise error.general('invalid cvs tag: %s' % (a))
267            source['tag'] = _as[1]
268        elif _as[0] == 'date':
269            if len(_as) != 2:
270                raise error.general('invalid cvs date: %s' % (a))
271            source['date'] = _as[1]
272    if 'date' in source and 'tag' in source:
273        raise error.general('cvs URL cannot have a date and tag: %s' % (source['url']))
274    # Do here to ensure an ordered path, the URL can include options in any order
275    if 'module' in source:
276        source['file'] += '_%s' % (source['module'])
277    if 'tag' in source:
278        source['file'] += '_%s' % (source['tag'])
279    if 'date' in source:
280        source['file'] += '_%s' % (source['date'])
281    for c in '/@#%.-':
282        source['file'] = source['file'].replace(c, '_')
283    source['local'] = path.join(source['local_prefix'], 'cvs', source['file'])
284    if 'src_prefix' in source:
285        source['symlink'] = path.join(source['local'], source['src_prefix'])
286    else:
287        source['symlink'] = source['local']
288
289def _file_parser(source, pathkey, config, opts):
290    #
291    # Check local path
292    #
293    _local_path(source, pathkey, config)
294    #
295    # Get the paths sorted.
296    #
297    source['file'] = source['url'][6:]
298
299parsers = { 'http': _http_parser,
300            'ftp':  _http_parser,
301            'pw':   _patchworks_parser,
302            'git':  _git_parser,
303            'cvs':  _cvs_parser,
304            'file': _file_parser }
305
306def set_release_path(release_path, macros):
307    if release_path is None:
308        release_path = '%{rtems_release_url}/%{rsb_version}/sources'
309    macros.define('release_path', release_path)
310
311def parse_url(url, pathkey, config, opts, file_override = None):
312    #
313    # Split the source up into the parts we need.
314    #
315    source = {}
316    source['url'] = url
317    source['options'] = []
318    colon = url.find(':')
319    if url[colon + 1:colon + 3] != '//':
320        raise error.general('malforned URL (no protocol prefix): %s' % (url))
321    source['path'] = url[:colon + 3] + path.dirname(url[colon + 3:])
322    if file_override is None:
323        source['file'] = path.basename(url)
324    else:
325        bad_chars = [c for c in ['/', '\\', '?', '*'] if c in file_override]
326        if len(bad_chars) > 0:
327            raise error.general('bad characters in file name: %s' % (file_override))
328
329        log.output('download: file-override: %s' % (file_override))
330        source['file'] = file_override
331        source['options'] += ['file-override']
332    source['name'], source['ext'] = path.splitext(source['file'])
333    if source['name'].endswith('.tar'):
334        source['name'] = source['name'][:-4]
335        source['ext'] = '.tar' + source['ext']
336    #
337    # Get the file. Checks the local source directory first.
338    #
339    source['local'] = None
340    for p in parsers:
341        if url.startswith(p):
342            source['type'] = p
343            if parsers[p](source, pathkey, config, opts):
344                break
345    source['script'] = ''
346    return source
347
348def _http_downloader(url, local, config, opts):
349    if path.exists(local):
350        return True
351    #
352    # Hack for GitHub.
353    #
354    if url.startswith('https://api.github.com'):
355        url = urllib_parse.urljoin(url, config.expand('tarball/%{version}'))
356    dst = os.path.relpath(path.host(local))
357    log.output('download: (full) %s -> %s' % (url, dst))
358    log.notice('download: %s -> %s' % (_sensible_url(url, len(dst)), dst))
359    failed = False
360    if _do_download(opts):
361        _in = None
362        _out = None
363        _length = None
364        _have = 0
365        _chunk_size = 256 * 1024
366        _chunk = None
367        _last_percent = 200.0
368        _last_msg = ''
369        _have_status_output = False
370        _url = url
371        try:
372            try:
373                _in = None
374                _ssl_context = None
375                # See #2656
376                _req = urllib_request.Request(_url)
377                _req.add_header('User-Agent', 'Wget/1.16.3 (freebsd10.1)')
378                try:
379                    import ssl
380                    _ssl_context = ssl._create_unverified_context()
381                    _in = urllib_request.urlopen(_req, context = _ssl_context)
382                except:
383                    log.output('download: no ssl context')
384                    _ssl_context = None
385                if _ssl_context is None:
386                    _in = urllib_request.urlopen(_req)
387                if _url != _in.geturl():
388                    _url = _in.geturl()
389                    log.output(' redirect: %s' % (_url))
390                    log.notice(' redirect: %s' % (_sensible_url(_url)))
391                _out = open(path.host(local), 'wb')
392                try:
393                    _length = int(_in.info()['Content-Length'].strip())
394                except:
395                    pass
396                while True:
397                    _msg = '\rdownloading: %s - %s ' % (dst, _humanize_bytes(_have))
398                    if _length:
399                        _percent = round((float(_have) / _length) * 100, 2)
400                        if _percent != _last_percent:
401                            _msg += 'of %s (%0.0f%%) ' % (_humanize_bytes(_length), _percent)
402                    if _msg != _last_msg:
403                        extras = (len(_last_msg) - len(_msg))
404                        log.stdout_raw('%s%s' % (_msg, ' ' * extras + '\b' * extras))
405                        _last_msg = _msg
406                        _have_status_output = True
407                    _chunk = _in.read(_chunk_size)
408                    if not _chunk:
409                        break
410                    _out.write(_chunk)
411                    _have += len(_chunk)
412                log.stdout_raw('\n\r')
413            except:
414                if _have_status_output:
415                    log.stdout_raw('\n\r')
416                raise
417        except IOError as err:
418            log.notice('download: %s: error: %s' % (_sensible_url(_url), str(err)))
419            if path.exists(local):
420                os.remove(path.host(local))
421            failed = True
422        except ValueError as err:
423            log.notice('download: %s: error: %s' % (_sensible_url(_url), str(err)))
424            if path.exists(local):
425                os.remove(path.host(local))
426            failed = True
427        except:
428            msg = 'download: %s: error' % (_sensible_url(_url))
429            log.stderr(msg)
430            log.notice(msg)
431            if _in is not None:
432                _in.close()
433            if _out is not None:
434                _out.close()
435            raise
436        if _out is not None:
437            _out.close()
438        if _in is not None:
439            _in.close()
440            del _in
441        if not failed:
442            if not path.isfile(local):
443                raise error.general('source is not a file: %s' % (path.host(local)))
444            if not _hash_check(path.basename(local), local, config.macros, False):
445                raise error.general('checksum failure file: %s' % (dst))
446    return not failed
447
448def _git_downloader(url, local, config, opts):
449    repo = git.repo(local, opts, config.macros)
450    rlp = os.path.relpath(path.host(local))
451    us = url.split('?')
452    #
453    # Handle the various git protocols.
454    #
455    # remove 'git' from 'git://xxxx/xxxx?protocol=...'
456    #
457    url_base = us[0][len('git'):]
458    for a in us[1:]:
459        _as = a.split('=')
460        if _as[0] == 'protocol':
461            if len(_as) != 2:
462                raise error.general('invalid git protocol option: %s' % (_as))
463            if _as[1] == 'none':
464                # remove the rest of the protocol header leaving nothing.
465                us[0] = url_base[len('://'):]
466            else:
467                if _as[1] not in ['ssh', 'git', 'http', 'https', 'ftp', 'ftps', 'rsync']:
468                    raise error.general('unknown git protocol: %s' % (_as[1]))
469                us[0] = _as[1] + url_base
470    if not repo.valid():
471        log.notice('git: clone: %s -> %s' % (us[0], rlp))
472        if _do_download(opts):
473            repo.clone(us[0], local)
474    else:
475        repo.clean(['-f', '-d'])
476        repo.reset('--hard')
477        repo.checkout('master')
478    for a in us[1:]:
479        _as = a.split('=')
480        if _as[0] == 'branch' or _as[0] == 'checkout':
481            if len(_as) != 2:
482                raise error.general('invalid git branch/checkout: %s' % (_as))
483            log.notice('git: checkout: %s => %s' % (us[0], _as[1]))
484            if _do_download(opts):
485                repo.checkout(_as[1])
486        elif _as[0] == 'submodule':
487            if len(_as) != 2:
488                raise error.general('invalid git submodule: %s' % (_as))
489            log.notice('git: submodule: %s <= %s' % (us[0], _as[1]))
490            if _do_download(opts):
491                repo.submodule(_as[1])
492        elif _as[0] == 'fetch':
493            log.notice('git: fetch: %s -> %s' % (us[0], rlp))
494            if _do_download(opts):
495                repo.fetch()
496        elif _as[0] == 'merge':
497            log.notice('git: merge: %s' % (us[0]))
498            if _do_download(opts):
499                repo.merge()
500        elif _as[0] == 'pull':
501            log.notice('git: pull: %s' % (us[0]))
502            if _do_download(opts):
503                repo.pull()
504        elif _as[0] == 'reset':
505            arg = []
506            if len(_as) > 1:
507                arg = ['--%s' % (_as[1])]
508            log.notice('git: reset: %s' % (us[0]))
509            if _do_download(opts):
510                repo.reset(arg)
511        elif _as[0] == 'protocol':
512            pass
513        else:
514            raise error.general('invalid git option: %s' % (_as))
515    return True
516
517def _cvs_downloader(url, local, config, opts):
518    rlp = os.path.relpath(path.host(local))
519    us = url.split('?')
520    module = None
521    tag = None
522    date = None
523    src_prefix = None
524    for a in us[1:]:
525        _as = a.split('=')
526        if _as[0] == 'module':
527            if len(_as) != 2:
528                raise error.general('invalid cvs module: %s' % (a))
529            module = _as[1]
530        elif _as[0] == 'src-prefix':
531            if len(_as) != 2:
532                raise error.general('invalid cvs src-prefix: %s' % (a))
533            src_prefix = _as[1]
534        elif _as[0] == 'tag':
535            if len(_as) != 2:
536                raise error.general('invalid cvs tag: %s' % (a))
537            tag = _as[1]
538        elif _as[0] == 'date':
539            if len(_as) != 2:
540                raise error.general('invalid cvs date: %s' % (a))
541            date = _as[1]
542    repo = cvs.repo(local, opts, config.macros, src_prefix)
543    if not repo.valid():
544        if not path.isdir(local):
545            log.notice('Creating source directory: %s' % \
546                           (os.path.relpath(path.host(local))))
547            if _do_download(opts):
548                path.mkdir(local)
549            log.notice('cvs: checkout: %s -> %s' % (us[0], rlp))
550            if _do_download(opts):
551                repo.checkout(':%s' % (us[0][6:]), module, tag, date)
552    for a in us[1:]:
553        _as = a.split('=')
554        if _as[0] == 'update':
555            log.notice('cvs: update: %s' % (us[0]))
556            if _do_download(opts):
557                repo.update()
558        elif _as[0] == 'reset':
559            log.notice('cvs: reset: %s' % (us[0]))
560            if _do_download(opts):
561                repo.reset()
562    return True
563
564def _file_downloader(url, local, config, opts):
565    if not path.exists(local):
566        try:
567            src = url[7:]
568            dst = local
569            log.notice('download: copy %s -> %s' % (src, dst))
570            path.copy(src, dst)
571        except:
572            return False
573    return True
574
575downloaders = { 'http': _http_downloader,
576                'ftp':  _http_downloader,
577                'pw':   _http_downloader,
578                'git':  _git_downloader,
579                'cvs':  _cvs_downloader,
580                'file': _file_downloader }
581
582def get_file(url, local, opts, config):
583    if local is None:
584        raise error.general('source/patch path invalid')
585    if not path.isdir(path.dirname(local)) and not opts.download_disabled():
586        log.notice('Creating source directory: %s' % \
587                       (os.path.relpath(path.host(path.dirname(local)))))
588    log.output('making dir: %s' % (path.host(path.dirname(local))))
589    if _do_download(opts):
590        path.mkdir(path.dirname(local))
591    if not path.exists(local) and opts.download_disabled():
592        raise error.general('source not found: %s' % (path.host(local)))
593    #
594    # Check if a URL has been provided on the command line. If the package is
595    # released push to the start the RTEMS URL unless overrided by the command
596    # line option --with-release-url. The variant --without-release-url can
597    # override the released check.
598    #
599    url_bases = opts.urls()
600    try:
601        rtems_release_url_value = config.macros.expand('%{release_path}')
602    except:
603        rtems_release_url_value = None
604        log.output('RTEMS release URL could not be expanded')
605    rtems_release_url = None
606    if version.released() and rtems_release_url_value:
607        rtems_release_url = rtems_release_url_value
608    with_rel_url = opts.with_arg('release-url')
609    if with_rel_url[1] == 'not-found':
610        if config.defined('without_release_url'):
611            with_rel_url = ('without_release-url', 'yes')
612    if with_rel_url[0] == 'with_release-url':
613        if with_rel_url[1] == 'yes':
614            if rtems_release_url_value is None:
615                raise error.general('no valid release URL')
616            rtems_release_url = rtems_release_url_value
617        elif with_rel_url[1] == 'no':
618            pass
619        else:
620            rtems_release_url = with_rel_url[1]
621    elif with_rel_url[0] == 'without_release-url' and with_rel_url[1] == 'yes':
622        rtems_release_url = None
623    if rtems_release_url is not None:
624        log.trace('release url: %s' % (rtems_release_url))
625        #
626        # If the URL being fetched is under the release path do not add the
627        # sources release path because it is already there.
628        #
629        if not url.startswith(rtems_release_url):
630            if url_bases is None:
631                url_bases = [rtems_release_url]
632            else:
633                url_bases.append(rtems_release_url)
634    urls = []
635    if url_bases is not None:
636        #
637        # Split up the URL we are being asked to download.
638        #
639        url_path = urllib_parse.urlsplit(url)[2]
640        slash = url_path.rfind('/')
641        if slash < 0:
642            url_file = url_path
643        else:
644            url_file = url_path[slash + 1:]
645        log.trace('url_file: %s' %(url_file))
646        for base in url_bases:
647            if base[-1:] != '/':
648                base += '/'
649            next_url = urllib_parse.urljoin(base, url_file)
650            log.trace('url: %s' %(next_url))
651            urls.append(next_url)
652    urls += url.split()
653    log.trace('_url: %s -> %s' % (','.join(urls), local))
654    for url in urls:
655        for dl in downloaders:
656            if url.startswith(dl):
657                if downloaders[dl](url, local, config, opts):
658                    return
659    if _do_download(opts):
660        raise error.general('downloading %s: all paths have failed, giving up' % (url))
Note: See TracBrowser for help on using the repository browser.