2 Decentralized storage grid.
4 community web site: U{https://tahoe-lafs.org/}
7 class PackagingError(EnvironmentError):
9 Raised when there is an error in packaging of Tahoe-LAFS or its
10 dependencies which makes it impossible to proceed safely.
14 __version__ = "unknown"
16 from allmydata._version import __version__
18 # We're running in a tree that hasn't run update_version, and didn't
19 # come with a _version.py, so we don't know what our version is.
20 # This should not happen very often.
23 full_version = "unknown"
26 from allmydata._version import full_version, branch
28 # We're running in a tree that hasn't run update_version, and didn't
29 # come with a _version.py, so we don't know what our full version or
30 # branch is. This should not happen very often.
33 __appname__ = "unknown"
35 from allmydata._appname import __appname__
37 # We're running in a tree that hasn't run "./setup.py". This shouldn't happen.
40 # __full_version__ is the one that you ought to use when identifying yourself in the
41 # "application" part of the Tahoe versioning scheme:
42 # https://tahoe-lafs.org/trac/tahoe-lafs/wiki/Versioning
43 __full_version__ = __appname__ + '/' + str(__version__)
45 import os, platform, re, subprocess, sys, traceback
46 _distributor_id_cmdline_re = re.compile("(?:Distributor ID:)\s*(.*)", re.I)
47 _release_cmdline_re = re.compile("(?:Release:)\s*(.*)", re.I)
49 _distributor_id_file_re = re.compile("(?:DISTRIB_ID\s*=)\s*(.*)", re.I)
50 _release_file_re = re.compile("(?:DISTRIB_RELEASE\s*=)\s*(.*)", re.I)
52 global _distname,_version
56 def get_linux_distro():
57 """ Tries to determine the name of the Linux OS distribution name.
59 First, try to parse a file named "/etc/lsb-release". If it exists, and
60 contains the "DISTRIB_ID=" line and the "DISTRIB_RELEASE=" line, then return
61 the strings parsed from that file.
63 If that doesn't work, then invoke platform.dist().
65 If that doesn't work, then try to execute "lsb_release", as standardized in
68 http://refspecs.freestandards.org/LSB_1.0.0/gLSB/lsbrelease.html
70 The current version of the standard is here:
72 http://refspecs.freestandards.org/LSB_3.2.0/LSB-Core-generic/LSB-Core-generic/lsbrelease.html
74 that lsb_release emitted, as strings.
76 Returns a tuple (distname,version). Distname is what LSB calls a
77 "distributor id", e.g. "Ubuntu". Version is what LSB calls a "release",
80 A version of this has been submitted to python as a patch for the standard
81 library module "platform":
83 http://bugs.python.org/issue3937
85 global _distname,_version
86 if _distname and _version:
87 return (_distname, _version)
90 etclsbrel = open("/etc/lsb-release", "rU")
91 for line in etclsbrel:
92 m = _distributor_id_file_re.search(line)
94 _distname = m.group(1).strip()
95 if _distname and _version:
96 return (_distname, _version)
97 m = _release_file_re.search(line)
99 _version = m.group(1).strip()
100 if _distname and _version:
101 return (_distname, _version)
102 except EnvironmentError:
105 (_distname, _version) = platform.dist()[:2]
106 if _distname and _version:
107 return (_distname, _version)
109 if os.path.isfile("/usr/bin/lsb_release") or os.path.isfile("/bin/lsb_release"):
111 p = subprocess.Popen(["lsb_release", "--all"], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
114 for line in p.stdout.readlines():
115 m = _distributor_id_cmdline_re.search(line)
117 _distname = m.group(1).strip()
118 if _distname and _version:
119 return (_distname, _version)
121 m = _release_cmdline_re.search(p.stdout.read())
123 _version = m.group(1).strip()
124 if _distname and _version:
125 return (_distname, _version)
126 except EnvironmentError:
129 if os.path.exists("/etc/arch-release"):
130 return ("Arch_Linux", "")
132 return (_distname,_version)
135 # Our version of platform.platform(), telling us both less and more than the
136 # Python Standard Library's version does.
137 # We omit details such as the Linux kernel version number, but we add a
138 # more detailed and correct rendition of the Linux distribution and
139 # distribution-version.
140 if "linux" in platform.system().lower():
141 return platform.system()+"-"+"_".join(get_linux_distro())+"-"+platform.machine()+"-"+"_".join([x for x in platform.architecture() if x])
143 return platform.platform()
146 from allmydata.util import verlib
147 def normalized_version(verstr, what=None):
149 return verlib.NormalizedVersion(verlib.suggest_normalized_version(verstr))
150 except (StandardError, verlib.IrrationalVersionError):
151 cls, value, trace = sys.exc_info()
152 raise PackagingError, ("could not parse %s due to %s: %s"
153 % (what or repr(verstr), cls.__name__, value)), trace
155 def get_openssl_version():
157 from OpenSSL import SSL
158 return extract_openssl_version(SSL)
160 return ("unknown", None, None)
162 def extract_openssl_version(ssl_module):
163 openssl_version = ssl_module.SSLeay_version(ssl_module.SSLEAY_VERSION)
164 if openssl_version.startswith('OpenSSL '):
165 openssl_version = openssl_version[8 :]
167 (version, _, comment) = openssl_version.partition(' ')
170 openssl_cflags = ssl_module.SSLeay_version(ssl_module.SSLEAY_CFLAGS)
171 if '-DOPENSSL_NO_HEARTBEATS' in openssl_cflags.split(' '):
172 comment += ", no heartbeats"
176 return (version, None, comment if comment else None)
178 def get_package_versions_and_locations():
180 from _auto_deps import package_imports, global_deprecation_messages, deprecation_messages, \
181 runtime_warning_messages, warning_imports
183 def package_dir(srcfile):
184 return os.path.dirname(os.path.dirname(os.path.normcase(os.path.realpath(srcfile))))
186 # pkg_resources.require returns the distribution that pkg_resources attempted to put
187 # on sys.path, which can differ from the one that we actually import due to #1258,
188 # or any other bug that causes sys.path to be set up incorrectly. Therefore we
189 # must import the packages in order to check their versions and paths.
191 # This is to suppress all UserWarnings and various DeprecationWarnings and RuntimeWarnings
192 # (listed in _auto_deps.py).
194 warnings.filterwarnings("ignore", category=UserWarning, append=True)
196 for msg in global_deprecation_messages + deprecation_messages:
197 warnings.filterwarnings("ignore", category=DeprecationWarning, message=msg, append=True)
198 for msg in runtime_warning_messages:
199 warnings.filterwarnings("ignore", category=RuntimeWarning, message=msg, append=True)
201 for modulename in warning_imports:
203 __import__(modulename)
207 # Leave suppressions for UserWarnings and global_deprecation_messages active.
208 for ign in runtime_warning_messages + deprecation_messages:
209 warnings.filters.pop()
213 def get_version(module):
214 if hasattr(module, '__version__'):
215 return str(getattr(module, '__version__'))
216 elif hasattr(module, 'version'):
217 ver = getattr(module, 'version')
218 if isinstance(ver, tuple):
219 return '.'.join(map(str, ver))
225 for pkgname, modulename in [(__appname__, 'allmydata')] + package_imports:
228 __import__(modulename)
229 module = sys.modules[modulename]
231 etype, emsg, etrace = sys.exc_info()
232 trace_info = (etype, str(emsg), ([None] + traceback.extract_tb(etrace))[-1])
233 packages.append( (pkgname, (None, None, trace_info)) )
236 if pkgname == __appname__:
237 comment = "%s: %s" % (branch, full_version)
238 elif pkgname == 'setuptools' and hasattr(module, '_distribute'):
239 # distribute does not report its version in any module variables
240 comment = 'distribute'
241 packages.append( (pkgname, (get_version(module), package_dir(module.__file__), comment)) )
242 elif pkgname == 'python':
243 packages.append( (pkgname, (platform.python_version(), sys.executable, None)) )
244 elif pkgname == 'platform':
245 packages.append( (pkgname, (get_platform(), None, None)) )
246 elif pkgname == 'OpenSSL':
247 packages.append( (pkgname, get_openssl_version()) )
252 def check_requirement(req, vers_and_locs):
253 # We support only conjunctions of <=, >=, and !=
255 reqlist = req.split(',')
256 name = reqlist[0].split('<=')[0].split('>=')[0].split('!=')[0].strip(' ').split('[')[0]
257 if name not in vers_and_locs:
258 raise PackagingError("no version info for %s" % (name,))
259 if req.strip(' ') == name:
261 (actual, location, comment) = vers_and_locs[name]
263 # comment is (type, message, (filename, line number, function name, text)) for the original ImportError
264 raise ImportError("for requirement %r: %s" % (req, comment))
265 if actual == 'unknown':
267 actualver = normalized_version(actual, what="actual version %r of %s from %r" % (actual, name, location))
269 if not match_requirement(req, reqlist, actualver):
270 msg = ("We require %s, but could only find version %s.\n" % (req, actual))
271 if location and location != 'unknown':
272 msg += "The version we found is from %r.\n" % (location,)
273 msg += ("To resolve this problem, uninstall that version, either using your\n"
274 "operating system's package manager or by moving aside the directory.")
275 raise PackagingError(msg)
278 def match_requirement(req, reqlist, actualver):
282 required = s[1].strip(' ')
283 if not (actualver <= normalized_version(required, what="required maximum version %r in %r" % (required, req))):
284 return False # maximum requirement not met
288 required = s[1].strip(' ')
289 if not (actualver >= normalized_version(required, what="required minimum version %r in %r" % (required, req))):
290 return False # minimum requirement not met
294 required = s[1].strip(' ')
295 if not (actualver != normalized_version(required, what="excluded version %r in %r" % (required, req))):
296 return False # not-equal requirement not met
298 raise PackagingError("no version info or could not understand requirement %r" % (req,))
303 _vers_and_locs_list = get_package_versions_and_locations()
306 def cross_check_pkg_resources_versus_import():
307 """This function returns a list of errors due to any failed cross-checks."""
310 from _auto_deps import install_requires
312 pkg_resources_vers_and_locs = dict([(p.project_name.lower(), (str(p.version), p.location))
313 for p in pkg_resources.require(install_requires)])
315 return cross_check(pkg_resources_vers_and_locs, _vers_and_locs_list)
318 def cross_check(pkg_resources_vers_and_locs, imported_vers_and_locs_list):
319 """This function returns a list of errors due to any failed cross-checks."""
321 from _auto_deps import not_import_versionable, ignorable
324 not_pkg_resourceable = ['python', 'platform', __appname__.lower(), 'openssl']
326 for name, (imp_ver, imp_loc, imp_comment) in imported_vers_and_locs_list:
328 if name not in not_pkg_resourceable:
329 if name not in pkg_resources_vers_and_locs:
330 if name == "setuptools" and "distribute" in pkg_resources_vers_and_locs:
331 pr_ver, pr_loc = pkg_resources_vers_and_locs["distribute"]
332 if not (os.path.normpath(os.path.realpath(pr_loc)) == os.path.normpath(os.path.realpath(imp_loc))
333 and imp_comment == "distribute"):
334 errors.append("Warning: dependency 'setuptools' found to be version %r of 'distribute' from %r "
335 "by pkg_resources, but 'import setuptools' gave version %r [%s] from %r. "
336 "A version mismatch is expected, but a location mismatch is not."
337 % (pr_ver, pr_loc, imp_ver, imp_comment or 'probably *not* distribute', imp_loc))
339 errors.append("Warning: dependency %r (version %r imported from %r) was not found by pkg_resources."
340 % (name, imp_ver, imp_loc))
343 pr_ver, pr_loc = pkg_resources_vers_and_locs[name]
344 if imp_ver is None and imp_loc is None:
345 errors.append("Warning: dependency %r could not be imported. pkg_resources thought it should be possible "
346 "to import version %r from %r.\nThe exception trace was %r."
347 % (name, pr_ver, pr_loc, imp_comment))
351 pr_normver = normalized_version(pr_ver)
353 errors.append("Warning: version number %r found for dependency %r by pkg_resources could not be parsed. "
354 "The version found by import was %r from %r. "
355 "pkg_resources thought it should be found at %r. "
356 "The exception was %s: %s"
357 % (pr_ver, name, imp_ver, imp_loc, pr_loc, e.__class__.__name__, e))
359 if imp_ver == 'unknown':
360 if name not in not_import_versionable:
361 errors.append("Warning: unexpectedly could not find a version number for dependency %r imported from %r. "
362 "pkg_resources thought it should be version %r at %r."
363 % (name, imp_loc, pr_ver, pr_loc))
366 imp_normver = normalized_version(imp_ver)
368 errors.append("Warning: version number %r found for dependency %r (imported from %r) could not be parsed. "
369 "pkg_resources thought it should be version %r at %r. "
370 "The exception was %s: %s"
371 % (imp_ver, name, imp_loc, pr_ver, pr_loc, e.__class__.__name__, e))
373 if pr_ver == 'unknown' or (pr_normver != imp_normver):
374 if not os.path.normpath(os.path.realpath(pr_loc)) == os.path.normpath(os.path.realpath(imp_loc)):
375 errors.append("Warning: dependency %r found to have version number %r (normalized to %r, from %r) "
376 "by pkg_resources, but version %r (normalized to %r, from %r) by import."
377 % (name, pr_ver, str(pr_normver), pr_loc, imp_ver, str(imp_normver), imp_loc))
379 imported_packages = set([p.lower() for (p, _) in imported_vers_and_locs_list])
380 extra_vers_and_locs_list = []
381 for pr_name, (pr_ver, pr_loc) in pkg_resources_vers_and_locs.iteritems():
382 if pr_name not in imported_packages and pr_name not in ignorable:
383 errors.append("Warning: dependency %r (version %r) found by pkg_resources not found by import."
389 def get_error_string(errors, debug=False):
390 from allmydata._auto_deps import install_requires
392 msg = "\n%s\n" % ("\n".join(errors),)
395 "For debugging purposes, the PYTHONPATH was\n"
397 "install_requires was\n"
399 "sys.path after importing pkg_resources was\n"
401 % (os.environ.get('PYTHONPATH'), install_requires, (os.pathsep+"\n ").join(sys.path)) )
404 def check_all_requirements():
405 """This function returns a list of errors due to any failed checks."""
407 from allmydata._auto_deps import install_requires
411 # We require at least 2.6 on all platforms.
412 # (On Python 3, we'll have failed long before this point.)
413 if sys.version_info < (2, 6):
415 version_string = ".".join(map(str, sys.version_info))
417 version_string = repr(sys.version_info)
418 errors.append("Tahoe-LAFS currently requires Python v2.6 or greater (but less than v3), not %s"
421 vers_and_locs = dict(_vers_and_locs_list)
422 for requirement in install_requires:
424 check_requirement(requirement, vers_and_locs)
425 except (ImportError, PackagingError), e:
426 errors.append("%s: %s" % (e.__class__.__name__, e))
429 raise PackagingError(get_error_string(errors, debug=True))
431 check_all_requirements()
434 def get_package_versions():
435 return dict([(k, v) for k, (v, l, c) in _vers_and_locs_list])
437 def get_package_locations():
438 return dict([(k, l) for k, (v, l, c) in _vers_and_locs_list])
440 def get_package_versions_string(show_paths=False, debug=False):
442 for p, (v, loc, comment) in _vers_and_locs_list:
443 info = str(p) + ": " + str(v)
445 info = info + " [%s]" % str(comment)
447 info = info + " (%s)" % str(loc)
450 output = "\n".join(res) + "\n"
452 if not hasattr(sys, 'frozen'):
453 errors = cross_check_pkg_resources_versus_import()
455 output += get_error_string(errors, debug=debug)