summaryrefslogtreecommitdiff
path: root/exts/pip_lorry.py
blob: 8f7e3ab93bd97bd3e600b247dd9bce08b4033954 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
#!/usr/bin/env python
#
# Create a Baserock .lorry file for a given Python package
#
# Copyright (C) 2014  Codethink Limited
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

from __future__ import print_function

import subprocess
import requests
import json
import sys
import shutil
import tempfile
import xmlrpclib

#import parser.requirements # todo add this as a submodule
# i don't know what i was going on about here

import requirements

PYPI_URL = 'http://pypi.python.org/pypi'

def warn(*args, **kwargs):
    print('%s:' % sys.argv[0], *args, file=sys.stderr, **kwargs)

def error(*args, **kwargs):
    warn(*args, **kwargs)
    sys.exit(1)

def fetch_package_metadata(package_name):
    try:
        return requests.get('%s/%s/json' % (PYPI_URL, package_name)).json()
    except Exception as e:
        error("Couldn't fetch package metadata: ", e)

def find_repo_type(url):
    print('Finding repo type for %s' % url)

    vcss = [('git', 'clone'), ('hg', 'clone'),
            ('svn', 'checkout'), ('bzr', 'branch')]

    for (vcs, vcs_command) in vcss:
        print('Trying %s %s' % (vcs, vcs_command))
        tempdir = tempfile.mkdtemp()

        p = subprocess.Popen([vcs, vcs_command, url], stdout=subprocess.PIPE,
                             stderr=subprocess.PIPE, cwd=tempdir)

        _, _ = p.communicate()
        shutil.rmtree(tempdir)

        if p.returncode == 0:
            print('%s is a %s repo' % (url, vcs))
            return vcs

    print("%s doesn't seem to be a repo" % url)

    return None

def get_compression(url):
    bzip = 'bzip2'
    gzip = 'gzip'
    lzma = 'lzma'

    m = {'tar.gz': gzip, 'tgz': gzip, 'tar.Z': gzip,
           'tar.bz2': bzip, 'tbz2': bzip,
           'tar.lzma': lzma, 'tar.xz': lzma, 'tlz': lzma, 'txz': lzma}

    for x in [1, 2]:
        ext = '.'.join(url.split('.')[-x:])
        if ext in m: return m[ext]

    return None

# Assumption: url passed to this function must have a 'standard' tar extension
def make_tarball_lorry(name, url):
    lorry = {'type': 'tarball', 'url': url}
    compression = get_compression(url)
    if compression:
        lorry['compression'] = compression

    return json.dumps({name.lower() + "-tarball": lorry},
                      indent=4, sort_keys=True)

def ask_user(client, xs, fn, prompt='--> '):
    for n, x in enumerate(xs, 1):
        print('[%s]: %s' % (n, fn(x)))
    print('')

    s = raw_input(prompt)
    choice = int(s) if s.isdigit() else None
    choice = choice - 1 if choice != None and choice <= len(xs) else None

    if choice == None:
        print("Invalid choice", file=sys.stderr)
        sys.exit(1)

    return choice

def filter_urls(urls):
    allowed_extensions = ['tar.gz', 'tgz', 'tar.Z', 'tar.bz2', 'tbz2',
                          'tar.lzma', 'tar.xz', 'tlz', 'txz', 'tar']

    def allowed_extension(url):
        return ('.'.join(url['url'].split('.')[-2:]) in allowed_extensions
            or url['url'].split('.')[-1:] in allowed_extensions)

    return filter(allowed_extension, urls)

def specs_satisfied(version, specs):
    def mapping_error(op):
        # We parse ops with requirements-parser, so any invalid user input
        # should be detected there. This really guards against
        # the pip developers adding some new operation to a requirement.
        error("Invalid op in spec: %s" % op)

    opmap = {'==' : lambda x, y: x == y, '!=' : lambda x, y: x != y,
             '<=' : lambda x, y: x <= y, '>=' : lambda x, y: x >= y,
             '<': lambda x, y: x < y, '>' : lambda x, y: x > y}

    def get_op_func(op):
        return opmap[op] if op in opmap else lambda x, y: mapping_error(op)

    return all([get_op_func(op)(version, sv) for (op, sv) in specs])

def generate_tarball_lorry(requirement):
    try:
        client = xmlrpclib.ServerProxy(PYPI_URL)
        releases = client.package_releases(requirement.name)
    except Exception as e:
        error("Couldn't fetch release data:", e)

    if len(releases) == 0:
        error("Couldn't find any releases for package %s" % requirement.name)

    releases = [v for v in releases if specs_satisfied(v, requirement.specs)]

    if len(releases) == 0:
        error("Couldn't find any releases that satisfy version constraints: %s"
              % requirement.specs)

    def get_description(release):
        return client.release_data(requirement.name,
                                   release)['name'] + ' ' + release

    choice = (ask_user(client, releases,
                       get_description, prompt='Select release: ')
                       if len(releases) > 1 else 0)
    release_version = releases[choice]

    print('Fetching urls for package %s with version %s'
          % (requirement.name, release_version))

    try:
        urls = client.release_urls(requirement.name, release_version)
    except Exception as e:
        error("Couldn't fetch release urls:", e)

    tarball_urls = filter_urls(urls)

    if len(tarball_urls) > 0:
        urls = tarball_urls
    elif len(urls) > 0:
        warn("None of these urls look like tarballs:")
        for url in urls:
            warn("\t%s", url)
        error("Cannot proceed")
    else:
        error("Couldn't find any download urls for package")

    choice = (ask_user(client, urls, lambda url: url['url'],
                       prompt='Select url: ') if len(urls) > 1 else 0)
    url = urls[choice]['url']

    return make_tarball_lorry(requirement.name, url)

def str_repo_lorry(package_name, repo_type, url):
    return json.dumps({package_name.lower(): {'type': repo_type, 'url': url}},
                      indent=4, sort_keys=True)

if __name__ == '__main__':
    max_args = 2

    if len(sys.argv) != max_args:
        # TODO explain the format of python requirements
        # warn the user that they probably want to quote their arg
        # > < will be interpreted as redirection by the shell
        print('usage: %s requirement'
              % sys.argv[0], file=sys.stderr)
        sys.exit(1)

    # TODO: We could take multiple reqs easily enough
    req = requirements.parse(sys.argv[1]).next()

    metadata = fetch_package_metadata(req.name)
    info = metadata['info']

    repo_type = (find_repo_type(info['home_page'])
                 if 'home_page' in info else None)

    print(str_repo_lorry(req.name, repo_type, info['home_page'])
            if repo_type else generate_tarball_lorry(req))