source: orange/Orange/utils/addons.py @ 11027:ad2ae0d2af82

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

Add-ons: if an add-on exists only on disk, fill its description with some non-None values, so that GUI doesn't crash.

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, 'c')
51    list(addons.items())  # Try to read the whole list.
52except:
53    if os.path.isfile(AOLIST_FILE):
54        os.remove(AOLIST_FILE)
55    addons = shelve.open(AOLIST_FILE, 'n')
56
57addons_corrupted = len(addons)==0
58
59addon_refresh_callback = []
60
61global index
62index = defaultdict(list)
63def rebuild_index():
64    global index
65
66    index = defaultdict(list)
67    for name, ao in addons.items():
68        for s in [name, ao.summary, ao.description, ao.author] + (ao.keywords if ao.keywords else []):
69            if not s:
70                continue
71            words = [word for word in re.split(INDEX_RE, s.lower())
72                     if len(word)>1]
73            for word in words:
74                for i in range(len(word)):
75                    index[word[:i+1]].append(name)
76
77def search_index(query):
78    global index
79    result = set()
80    words = [word for word in re.split(INDEX_RE, query.lower()) if len(word)>1]
81    if not words:
82        return addons.keys()
83    for word in words:
84        result.update(index[word])
85    return result
86
87def refresh_available_addons(force=False, progress_callback=None):
88    pypi = xmlrpclib.ServerProxy('http://pypi.python.org/pypi')
89    if progress_callback:
90        progress_callback(1, 0)
91
92    pkg_dict = {}
93    for data in pypi.search({'keywords': 'orange'}):
94        name = data['name']
95        order = data['_pypi_ordering']
96        if name not in pkg_dict or pkg_dict[name][0] < order:
97            pkg_dict[name] = (order, data['version'])
98
99    try:
100        import slumber
101        readthedocs = slumber.API(base_url='http://readthedocs.org/api/v1/')
102    except:
103        readthedocs = None
104
105    docs = {}
106    if progress_callback:
107        progress_callback(len(pkg_dict)+1, 1)
108    for i, (name, (_, version)) in enumerate(pkg_dict.items()):
109        if force or name not in addons or addons[name].available_version != version:
110            try:
111                data = pypi.release_data(name, version)
112                rel = pypi.release_urls(name, version)[0]
113
114                if readthedocs:
115                    try:
116                        docs = readthedocs.project.get(slug=name.lower())['objects'][0]
117                    except:
118                        docs = {}
119                addons[name] = OrangeAddOn(name = name,
120                                           available_version = data['version'],
121                                           installed_version = addons[name].installed_version if name in addons else None,
122                                           summary = data['summary'],
123                                           description = data.get('description', ''),
124                                           author = str((data.get('author', '') or '') + ' ' + (data.get('author_email', '') or '')).strip(),
125                                           docs_url = data.get('docs_url', docs.get('subdomain', '')),
126                                           keywords = data.get('keywords', "").split(","),
127                                           homepage = data.get('home_page', ''),
128                                           package_url = data.get('package_url', ''),
129                                           release_url = rel.get('url', None),
130                                           release_size = rel.get('size', -1),
131                                           python_version = rel.get('python_version', None))
132            except Exception, e:
133                import traceback
134                traceback.print_exc()
135                warnings.warn('Could not load data for the following add-on: %s'%name)
136        if progress_callback:
137            progress_callback(len(pkg_dict)+1, i+2)
138    addons_corrupted = False
139    addons.sync()
140
141    rebuild_index()
142
143def load_installed_addons():
144    found = set()
145    for entry_point in pkg_resources.iter_entry_points(ADDONS_ENTRY_POINT):
146        name, version = entry_point.dist.project_name, entry_point.dist.version
147        #TODO We could import setup.py from entry_point.location and load descriptions and such ...
148        if name in addons:
149            addons[name] = addons[name]._replace(installed_version = version)
150        else:
151            addons[name] = OrangeAddOn(name = name,
152                available_version = None,
153                installed_version = version,
154                summary = "",
155                description = "",
156                author = "",
157                docs_url = "",
158                keywords = "",
159                homepage = "",
160                package_url = "",
161                release_url = "",
162                release_size = None,
163                python_version = None)
164        found.add(name)
165    for name in set(addons).difference(found):
166        addons[name] = addons[name]._replace(installed_version = None)
167    addons.sync()
168    rebuild_index()
169
170def run_setup(setup_script, args):
171    old_dir = os.getcwd()
172    save_argv = sys.argv[:]
173    save_path = sys.path[:]
174    setup_dir = os.path.abspath(os.path.dirname(setup_script))
175    temp_dir = os.path.join(setup_dir,'temp')
176    if not os.path.isdir(temp_dir): os.makedirs(temp_dir)
177    save_tmp = tempfile.tempdir
178    save_modules = sys.modules.copy()
179    try:
180        tempfile.tempdir = temp_dir
181        os.chdir(setup_dir)
182        try:
183            sys.argv[:] = [setup_script]+list(args)
184            sys.path.insert(0, setup_dir)
185            execfile(
186                    "setup.py",
187                    {'__file__':setup_script, '__name__':'__main__'}
188                )
189        except SystemExit, v:
190            if v.args and v.args[0]:
191                raise
192                # Normal exit, just return
193    finally:
194        sys.modules.update(save_modules)
195        for key in list(sys.modules):
196            if key not in save_modules: del sys.modules[key]
197        os.chdir(old_dir)
198        sys.path[:] = save_path
199        sys.argv[:] = save_argv
200        tempfile.tempdir = save_tmp
201
202
203def install(name, progress_callback=None):
204    if progress_callback:
205        progress_callback(1, 0)
206    import site
207    try:
208        import urllib
209        rh = (lambda done, bs, fs: progress_callback(fs/bs, done)) if progress_callback else None
210        egg = urllib.urlretrieve(addons[name].release_url, reporthook=rh)[0]
211    except Exception, e:
212        raise Exception("Unable to download add-on from repository: %s" % e)
213
214    try:
215        try:
216            tmpdir = tempfile.mkdtemp()
217            egg_contents = tarfile.open(egg)
218            egg_contents.extractall(tmpdir)
219            setup_py = os.path.join(tmpdir, name+'-'+addons[name].available_version, 'setup.py')
220        except Exception, e:
221            raise Exception("Unable to unpack add-on: %s" % e)
222
223        if not os.path.isfile(setup_py):
224            raise Exception("Unable to install add-on - it is not properly packed.")
225
226        try:
227            switches = []
228            if site.USER_SITE in sys.path:   # we're not in a virtualenv
229                switches.append('--user')
230            run_setup(setup_py, ['install'] + switches)
231        except Exception, e:
232            raise Exception("Unable to install add-on: %s" % e)
233    finally:
234        shutil.rmtree(tmpdir, ignore_errors=True)
235
236    for p in list(sys.path):
237        site.addsitedir(p)
238    reload(pkg_resources)
239    for p in list(sys.path):
240        pkg_resources.find_distributions(p)
241    from orngRegistry import load_new_addons
242    load_new_addons()
243    load_installed_addons()
244    for func in addon_refresh_callback:
245        func()
246
247def uninstall(name, progress_callback=None):
248    try:
249        import pip.req
250        ao = pip.req.InstallRequirement(name, None)
251        ao.uninstall(True)
252    except ImportError:
253        raise Exception("Pip is required for add-on uninstallation. Install pip and try again.")
254
255def upgrade(name, progress_callback=None):
256    install(name, progress_callback)
257
258load_installed_addons()
259
260
261
262# Support for loading legacy "registered" add-ons
263def __read_addons_list(addons_file, systemwide):
264    if os.path.isfile(addons_file):
265        return [tuple([x.strip() for x in lne.split("\t")])
266                for lne in file(addons_file, "rt")]
267    else:
268        return []
269
270registered = __read_addons_list(os.path.join(Orange.utils.environ.orange_settings_dir, "add-ons.txt"), False) + \
271             __read_addons_list(os.path.join(Orange.utils.environ.install_dir, "add-ons.txt"), True)
272
273for name, path in registered:
274    for p in [os.path.join(path, "widgets", "prototypes"),
275          os.path.join(path, "widgets"),
276          path,
277          os.path.join(path, "lib-%s" % "-".join(( sys.platform, "x86" if (platform.machine()=="")
278          else platform.machine(), ".".join(map(str, sys.version_info[:2])) )) )]:
279        if os.path.isdir(p) and not any([Orange.utils.environ.samepath(p, x)
280                                         for x in sys.path]):
281            if p not in sys.path:
282                sys.path.insert(0, p)
283
284#TODO Show some progress to the user at least during the installation procedure.
Note: See TracBrowser for help on using the repository browser.