source: orange/Orange/utils/addons.py @ 11021:258cd74e0722

Revision 11021:258cd74e0722, 10.3 KB checked in by Matija Polajnar <matija.polajnar@…>, 17 months ago (diff)

Show progress during installation of add-ons.

Line 
1from __future__ import absolute_import
2"""
3==============================
4Add-on Management (``addons``)
5==============================
6
7.. index:: add-ons
8
9Orange.utils.addons module provides a framework for Orange add-on management. As
10soon as it is imported, the following initialization takes place: the list of
11installed add-ons is loaded, their directories are added to python path
12(:obj:`sys.path`) the callback list is initialized, the stored repository list is
13loaded. The most important consequence of importing the module is thus the
14injection of add-ons into the namespace.
15
16"""
17
18#TODO Document this module.
19
20import socket
21import shelve
22import xmlrpclib
23import warnings
24import re
25import pkg_resources
26import tempfile
27import tarfile
28import shutil
29import os
30import sys
31import platform
32from collections import namedtuple, defaultdict
33
34import Orange.utils.environ
35
36ADDONS_ENTRY_POINT="orange.addons"
37
38socket.setdefaulttimeout(120)  # In seconds.
39
40OrangeAddOn = namedtuple('OrangeAddOn', ['name', 'available_version', 'installed_version', 'summary', 'description',
41                                         'author', 'docs_url', 'keywords', 'homepage', 'package_url',
42                                         'release_url', 'release_size', 'python_version'])
43#It'd be great if we could somehow read a list and descriptions of widgets, show them in the dialog and enable
44#search of add-ons based on keywords in widget names and descriptions.
45
46INDEX_RE = "[^a-z0-9-']"  # RE for splitting entries in the search index
47
48AOLIST_FILE = os.path.join(Orange.utils.environ.orange_settings_dir, "addons.shelve")
49try:
50    addons = shelve.open(AOLIST_FILE)
51    list(addons.items())  # Try to read the whole list.
52except:
53    addons = shelve.open(AOLIST_FILE, 'n')
54
55addon_refresh_callback = []
56
57global index
58index = defaultdict(list)
59def rebuild_index():
60    global index
61
62    index = defaultdict(list)
63    for name, ao in addons.items():
64        for s in [name, ao.summary, ao.description, ao.author] + (ao.keywords if ao.keywords else []):
65            if not s:
66                continue
67            words = [word for word in re.split(INDEX_RE, s.lower())
68                     if len(word)>1]
69            for word in words:
70                for i in range(len(word)):
71                    index[word[:i+1]].append(name)
72
73def search_index(query):
74    global index
75    result = set()
76    words = [word for word in re.split(INDEX_RE, query.lower()) if len(word)>1]
77    if not words:
78        return addons.keys()
79    for word in words:
80        result.update(index[word])
81    return result
82
83def refresh_available_addons(force=False, progress_callback=None):
84    pypi = xmlrpclib.ServerProxy('http://pypi.python.org/pypi')
85    if progress_callback:
86        progress_callback(1, 0)
87
88    pkg_dict = {}
89    for data in pypi.search({'keywords': 'orange'}):
90        name = data['name']
91        order = data['_pypi_ordering']
92        if name not in pkg_dict or pkg_dict[name][0] < order:
93            pkg_dict[name] = (order, data['version'])
94
95    try:
96        import slumber
97        readthedocs = slumber.API(base_url='http://readthedocs.org/api/v1/')
98    except:
99        readthedocs = None
100
101    docs = {}
102    if progress_callback:
103        progress_callback(len(pkg_dict)+1, 1)
104    for i, (name, (_, version)) in enumerate(pkg_dict.items()):
105        if force or name not in addons or addons[name].available_version != version:
106            try:
107                data = pypi.release_data(name, version)
108                rel = pypi.release_urls(name, version)[0]
109
110                if readthedocs:
111                    try:
112                        docs = readthedocs.project.get(slug=name.lower())['objects'][0]
113                    except:
114                        docs = {}
115                addons[name] = OrangeAddOn(name = name,
116                                           available_version = data['version'],
117                                           installed_version = addons[name].installed_version if name in addons else None,
118                                           summary = data['summary'],
119                                           description = data.get('description', ''),
120                                           author = str((data.get('author', '') or '') + ' ' + (data.get('author_email', '') or '')).strip(),
121                                           docs_url = data.get('docs_url', docs.get('subdomain', '')),
122                                           keywords = data.get('keywords', "").split(","),
123                                           homepage = data.get('home_page', ''),
124                                           package_url = data.get('package_url', ''),
125                                           release_url = rel.get('url', None),
126                                           release_size = rel.get('size', -1),
127                                           python_version = rel.get('python_version', None))
128            except Exception, e:
129                import traceback
130                traceback.print_exc()
131                warnings.warn('Could not load data for the following add-on: %s'%name)
132        if progress_callback:
133            progress_callback(len(pkg_dict)+1, i+2)
134
135    rebuild_index()
136
137def load_installed_addons():
138    #TODO Unload existing or what?
139
140    found = set()
141    for entry_point in pkg_resources.iter_entry_points(ADDONS_ENTRY_POINT):
142        name, version = entry_point.dist.project_name, entry_point.dist.version
143        #TODO We could import setup.py from entry_point.location and load descriptions and such ...
144        if name in addons:
145            addons[name] = addons[name]._replace(installed_version = version)
146        else:
147            addons[name] = OrangeAddOn(name = name,
148                available_version = None,
149                installed_version = version,
150                summary = None,
151                description = None,
152                author = None,
153                docs_url = None,
154                keywords = None,
155                homepage = None,
156                package_url = None,
157                release_url = None,
158                release_size = None,
159                python_version = None)  # We should find all those values out from the setup.py or somewhere ...
160        found.add(name)
161    for name in set(addons).difference(found):
162        addons[name] = addons[name]._replace(installed_version = None)
163    rebuild_index()
164
165def run_setup(setup_script, args):
166    old_dir = os.getcwd()
167    save_argv = sys.argv[:]
168    save_path = sys.path[:]
169    setup_dir = os.path.abspath(os.path.dirname(setup_script))
170    temp_dir = os.path.join(setup_dir,'temp')
171    if not os.path.isdir(temp_dir): os.makedirs(temp_dir)
172    save_tmp = tempfile.tempdir
173    save_modules = sys.modules.copy()
174    try:
175        tempfile.tempdir = temp_dir
176        os.chdir(setup_dir)
177        try:
178            sys.argv[:] = [setup_script]+list(args)
179            sys.path.insert(0, setup_dir)
180            execfile(
181                    "setup.py",
182                    {'__file__':setup_script, '__name__':'__main__'}
183                )
184        except SystemExit, v:
185            if v.args and v.args[0]:
186                raise
187                # Normal exit, just return
188    finally:
189        sys.modules.update(save_modules)
190        for key in list(sys.modules):
191            if key not in save_modules: del sys.modules[key]
192        os.chdir(old_dir)
193        sys.path[:] = save_path
194        sys.argv[:] = save_argv
195        tempfile.tempdir = save_tmp
196
197
198def install(name, progress_callback=None):
199    if progress_callback:
200        progress_callback(1, 0)
201    import site
202    try:
203        import urllib
204        rh = (lambda done, bs, fs: progress_callback(fs/bs, done)) if progress_callback else None
205        egg = urllib.urlretrieve(addons[name].release_url, reporthook=rh)[0]
206    except Exception, e:
207        raise Exception("Unable to download add-on from repository: %s" % e)
208
209    try:
210        try:
211            tmpdir = tempfile.mkdtemp()
212            egg_contents = tarfile.open(egg)
213            egg_contents.extractall(tmpdir)
214            setup_py = os.path.join(tmpdir, name+'-'+addons[name].available_version, 'setup.py')
215        except Exception, e:
216            raise Exception("Unable to unpack add-on: %s" % e)
217
218        if not os.path.isfile(setup_py):
219            raise Exception("Unable to install add-on - it is not properly packed.")
220
221        try:
222            switches = []
223            if site.USER_SITE in sys.path:   # we're not in a virtualenv
224                switches.append('--user')
225            run_setup(setup_py, ['install'] + switches)
226        except Exception, e:
227            raise Exception("Unable to install add-on: %s" % e)
228    finally:
229        shutil.rmtree(tmpdir, ignore_errors=True)
230
231    for p in list(sys.path):
232        site.addsitedir(p)
233    reload(pkg_resources)
234    for p in list(sys.path):
235        pkg_resources.find_distributions(p)
236    from orngRegistry import load_new_addons
237    load_new_addons()
238    load_installed_addons()
239    for func in addon_refresh_callback:
240        func()
241
242def uninstall(name, progress_callback=None): #TODO
243    raise Exception('Unable to uninstall %s: uninstallation of add-ons is not yet implemented.')
244    # Implement this either by using pip.commands.uninstall, and complain if pip is not installed on the system,
245    # or by "stealing" pip's uninstallation code.
246
247def upgrade(name, progress_callback=None):
248    install(name, progress_callback)
249
250load_installed_addons()
251
252
253
254# Support for loading legacy "registered" add-ons
255def __read_addons_list(addons_file, systemwide):
256    if os.path.isfile(addons_file):
257        return [tuple([x.strip() for x in lne.split("\t")])
258                for lne in file(addons_file, "rt")]
259    else:
260        return []
261
262registered = __read_addons_list(os.path.join(Orange.utils.environ.orange_settings_dir, "add-ons.txt"), False) + \
263             __read_addons_list(os.path.join(Orange.utils.environ.install_dir, "add-ons.txt"), True)
264
265for name, path in registered:
266    for p in [os.path.join(path, "widgets", "prototypes"),
267          os.path.join(path, "widgets"),
268          path,
269          os.path.join(path, "lib-%s" % "-".join(( sys.platform, "x86" if (platform.machine()=="")
270          else platform.machine(), ".".join(map(str, sys.version_info[:2])) )) )]:
271        if os.path.isdir(p) and not any([Orange.utils.environ.samepath(p, x)
272                                         for x in sys.path]):
273            if p not in sys.path:
274                sys.path.insert(0, p)
275
276#TODO Show some progress to the user at least during the installation procedure.
Note: See TracBrowser for help on using the repository browser.