"""
Decentralized storage grid.
-community web site: U{http://tahoe-lafs.org/}
+community web site: U{https://tahoe-lafs.org/}
"""
class PackagingError(EnvironmentError):
try:
from allmydata._version import __version__
except ImportError:
- # We're running in a tree that hasn't run "./setup.py darcsver", and didn't
- # come with a _version.py, so we don't know what our version is. This should
- # not happen very often.
+ # We're running in a tree that hasn't run update_version, and didn't
+ # come with a _version.py, so we don't know what our version is.
+ # This should not happen very often.
+ pass
+
+full_version = "unknown"
+branch = "unknown"
+try:
+ from allmydata._version import full_version, branch
+except ImportError:
+ # We're running in a tree that hasn't run update_version, and didn't
+ # come with a _version.py, so we don't know what our full version or
+ # branch is. This should not happen very often.
pass
__appname__ = "unknown"
# __full_version__ is the one that you ought to use when identifying yourself in the
# "application" part of the Tahoe versioning scheme:
-# http://allmydata.org/trac/tahoe/wiki/Versioning
+# https://tahoe-lafs.org/trac/tahoe-lafs/wiki/Versioning
__full_version__ = __appname__ + '/' + str(__version__)
-import os, platform, re, subprocess, sys
+import os, platform, re, subprocess, sys, traceback
_distributor_id_cmdline_re = re.compile("(?:Distributor ID:)\s*(.*)", re.I)
_release_cmdline_re = re.compile("(?:Release:)\s*(.*)", re.I)
if _distname and _version:
return (_distname, _version)
- try:
- p = subprocess.Popen(["lsb_release", "--all"], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
- rc = p.wait()
- if rc == 0:
- for line in p.stdout.readlines():
- m = _distributor_id_cmdline_re.search(line)
- if m:
- _distname = m.group(1).strip()
- if _distname and _version:
- return (_distname, _version)
-
- m = _release_cmdline_re.search(p.stdout.read())
- if m:
- _version = m.group(1).strip()
- if _distname and _version:
- return (_distname, _version)
- except EnvironmentError:
- pass
+ if os.path.isfile("/usr/bin/lsb_release") or os.path.isfile("/bin/lsb_release"):
+ try:
+ p = subprocess.Popen(["lsb_release", "--all"], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ rc = p.wait()
+ if rc == 0:
+ for line in p.stdout.readlines():
+ m = _distributor_id_cmdline_re.search(line)
+ if m:
+ _distname = m.group(1).strip()
+ if _distname and _version:
+ return (_distname, _version)
+
+ m = _release_cmdline_re.search(p.stdout.read())
+ if m:
+ _version = m.group(1).strip()
+ if _distname and _version:
+ return (_distname, _version)
+ except EnvironmentError:
+ pass
if os.path.exists("/etc/arch-release"):
return ("Arch_Linux", "")
from allmydata.util import verlib
-def normalized_version(verstr):
- return verlib.NormalizedVersion(verlib.suggest_normalized_version(verstr))
+def normalized_version(verstr, what=None):
+ try:
+ return verlib.NormalizedVersion(verlib.suggest_normalized_version(verstr))
+ except (StandardError, verlib.IrrationalVersionError):
+ cls, value, trace = sys.exc_info()
+ raise PackagingError, ("could not parse %s due to %s: %s"
+ % (what or repr(verstr), cls.__name__, value)), trace
+
+def get_openssl_version():
+ try:
+ from OpenSSL import SSL
+ return extract_openssl_version(SSL)
+ except Exception:
+ return ("unknown", None, None)
+
+def extract_openssl_version(ssl_module):
+ openssl_version = ssl_module.SSLeay_version(ssl_module.SSLEAY_VERSION)
+ if openssl_version.startswith('OpenSSL '):
+ openssl_version = openssl_version[8 :]
+
+ (version, _, comment) = openssl_version.partition(' ')
+
+ try:
+ openssl_cflags = ssl_module.SSLeay_version(ssl_module.SSLEAY_CFLAGS)
+ if '-DOPENSSL_NO_HEARTBEATS' in openssl_cflags.split(' '):
+ comment += ", no heartbeats"
+ except Exception:
+ pass
+ return (version, None, comment if comment else None)
def get_package_versions_and_locations():
import warnings
- from _auto_deps import package_imports, deprecation_messages, deprecation_imports
+ from _auto_deps import package_imports, global_deprecation_messages, deprecation_messages, \
+ runtime_warning_messages, warning_imports
def package_dir(srcfile):
return os.path.dirname(os.path.dirname(os.path.normcase(os.path.realpath(srcfile))))
# or any other bug that causes sys.path to be set up incorrectly. Therefore we
# must import the packages in order to check their versions and paths.
- # This warning is generated by twisted, PyRex, and possibly other packages,
- # but can happen at any time, not only when they are imported. See
- # http://tahoe-lafs.org/trac/tahoe-lafs/ticket/1129 .
- warnings.filterwarnings("ignore", category=DeprecationWarning,
- message="BaseException.message has been deprecated as of Python 2.6",
- append=True)
+ # This is to suppress all UserWarnings and various DeprecationWarnings and RuntimeWarnings
+ # (listed in _auto_deps.py).
- # This is to suppress various DeprecationWarnings that occur when modules are imported.
- # See http://allmydata.org/trac/tahoe/ticket/859 and http://divmod.org/trac/ticket/2994 .
+ warnings.filterwarnings("ignore", category=UserWarning, append=True)
- for msg in deprecation_messages:
+ for msg in global_deprecation_messages + deprecation_messages:
warnings.filterwarnings("ignore", category=DeprecationWarning, message=msg, append=True)
+ for msg in runtime_warning_messages:
+ warnings.filterwarnings("ignore", category=RuntimeWarning, message=msg, append=True)
try:
- for modulename in deprecation_imports:
+ for modulename in warning_imports:
try:
__import__(modulename)
except ImportError:
pass
finally:
- for ign in deprecation_messages:
+ # Leave suppressions for UserWarnings and global_deprecation_messages active.
+ for ign in runtime_warning_messages + deprecation_messages:
warnings.filters.pop()
packages = []
- def get_version(module, attr):
- return str(getattr(module, attr, 'unknown'))
+ def get_version(module):
+ if hasattr(module, '__version__'):
+ return str(getattr(module, '__version__'))
+ elif hasattr(module, 'version'):
+ ver = getattr(module, 'version')
+ if isinstance(ver, tuple):
+ return '.'.join(map(str, ver))
+ else:
+ return str(ver)
+ else:
+ return 'unknown'
for pkgname, modulename in [(__appname__, 'allmydata')] + package_imports:
if modulename:
__import__(modulename)
module = sys.modules[modulename]
except ImportError:
- packages.append((pkgname, (None, modulename)))
+ etype, emsg, etrace = sys.exc_info()
+ trace_info = (etype, str(emsg), ([None] + traceback.extract_tb(etrace))[-1])
+ packages.append( (pkgname, (None, None, trace_info)) )
else:
- if 'sqlite' in pkgname:
- packages.append( (pkgname, (get_version(module, 'version'), package_dir(module.__file__))) )
- packages.append( ('sqlite', (get_version(module, 'sqlite_version'), package_dir(module.__file__))) )
- else:
- packages.append( (pkgname, (get_version(module, '__version__'), package_dir(module.__file__))) )
+ comment = None
+ if pkgname == __appname__:
+ comment = "%s: %s" % (branch, full_version)
+ elif pkgname == 'setuptools' and hasattr(module, '_distribute'):
+ # distribute does not report its version in any module variables
+ comment = 'distribute'
+ packages.append( (pkgname, (get_version(module), package_dir(module.__file__), comment)) )
elif pkgname == 'python':
- packages.append( (pkgname, (platform.python_version(), sys.executable)) )
+ packages.append( (pkgname, (platform.python_version(), sys.executable, None)) )
elif pkgname == 'platform':
- packages.append( (pkgname, (get_platform(), None)) )
+ packages.append( (pkgname, (get_platform(), None, None)) )
+ elif pkgname == 'OpenSSL':
+ packages.append( (pkgname, get_openssl_version()) )
return packages
def check_requirement(req, vers_and_locs):
- # TODO: check [] options
- # We support only disjunctions of >= and ==
+ # We support only conjunctions of <=, >=, and !=
reqlist = req.split(',')
- name = reqlist[0].split('>=')[0].split('==')[0].strip(' ').split('[')[0]
+ name = reqlist[0].split('<=')[0].split('>=')[0].split('!=')[0].strip(' ').split('[')[0]
if name not in vers_and_locs:
raise PackagingError("no version info for %s" % (name,))
if req.strip(' ') == name:
return
- (actual, location) = vers_and_locs[name]
+ (actual, location, comment) = vers_and_locs[name]
if actual is None:
- raise ImportError("could not import %r for requirement %r" % (location, req))
+ # comment is (type, message, (filename, line number, function name, text)) for the original ImportError
+ raise ImportError("for requirement %r: %s" % (req, comment))
if actual == 'unknown':
return
- actualver = normalized_version(actual)
+ actualver = normalized_version(actual, what="actual version %r of %s from %r" % (actual, name, location))
+
+ if not match_requirement(req, reqlist, actualver):
+ msg = ("We require %s, but could only find version %s.\n" % (req, actual))
+ if location and location != 'unknown':
+ msg += "The version we found is from %r.\n" % (location,)
+ msg += ("To resolve this problem, uninstall that version, either using your\n"
+ "operating system's package manager or by moving aside the directory.")
+ raise PackagingError(msg)
+
+def match_requirement(req, reqlist, actualver):
for r in reqlist:
- s = r.split('>=')
+ s = r.split('<=')
if len(s) == 2:
required = s[1].strip(' ')
- if actualver >= normalized_version(required):
- return # minimum requirement met
+ if not (actualver <= normalized_version(required, what="required maximum version %r in %r" % (required, req))):
+ return False # maximum requirement not met
else:
- s = r.split('==')
+ s = r.split('>=')
if len(s) == 2:
required = s[1].strip(' ')
- if actualver == normalized_version(required):
- return # exact requirement met
+ if not (actualver >= normalized_version(required, what="required minimum version %r in %r" % (required, req))):
+ return False # minimum requirement not met
else:
- raise PackagingError("no version info or could not understand requirement %r" % (req,))
+ s = r.split('!=')
+ if len(s) == 2:
+ required = s[1].strip(' ')
+ if not (actualver != normalized_version(required, what="excluded version %r in %r" % (required, req))):
+ return False # not-equal requirement not met
+ else:
+ raise PackagingError("no version info or could not understand requirement %r" % (req,))
- msg = ("We require %s, but could only find version %s.\n" % (req, actual))
- if location and location != 'unknown':
- msg += "The version we found is from %r.\n" % (location,)
- msg += ("To resolve this problem, uninstall that version, either using your\n"
- "operating system's package manager or by moving aside the directory.")
- raise PackagingError(msg)
+ return True
_vers_and_locs_list = get_package_versions_and_locations()
import pkg_resources
from _auto_deps import install_requires
- errors = []
- not_pkg_resourceable = set(['sqlite', 'sqlite3', 'python', 'platform', __appname__.lower()])
- not_import_versionable = set(['zope.interface', 'mock', 'pyasn1'])
- ignorable = set(['argparse', 'pyutil', 'zbase32'])
-
pkg_resources_vers_and_locs = dict([(p.project_name.lower(), (str(p.version), p.location))
for p in pkg_resources.require(install_requires)])
- for name, (imp_ver, imp_loc) in _vers_and_locs_list:
+ return cross_check(pkg_resources_vers_and_locs, _vers_and_locs_list)
+
+
+def cross_check(pkg_resources_vers_and_locs, imported_vers_and_locs_list):
+ """This function returns a list of errors due to any failed cross-checks."""
+
+ from _auto_deps import not_import_versionable, ignorable
+
+ errors = []
+ not_pkg_resourceable = ['python', 'platform', __appname__.lower(), 'openssl']
+
+ for name, (imp_ver, imp_loc, imp_comment) in imported_vers_and_locs_list:
name = name.lower()
if name not in not_pkg_resourceable:
if name not in pkg_resources_vers_and_locs:
- errors.append("Warning: dependency %s (version %s imported from %r) was not found by pkg_resources."
- % (name, imp_ver, imp_loc))
+ if name == "setuptools" and "distribute" in pkg_resources_vers_and_locs:
+ pr_ver, pr_loc = pkg_resources_vers_and_locs["distribute"]
+ if not (os.path.normpath(os.path.realpath(pr_loc)) == os.path.normpath(os.path.realpath(imp_loc))
+ and imp_comment == "distribute"):
+ errors.append("Warning: dependency 'setuptools' found to be version %r of 'distribute' from %r "
+ "by pkg_resources, but 'import setuptools' gave version %r [%s] from %r. "
+ "A version mismatch is expected, but a location mismatch is not."
+ % (pr_ver, pr_loc, imp_ver, imp_comment or 'probably *not* distribute', imp_loc))
+ else:
+ errors.append("Warning: dependency %r (version %r imported from %r) was not found by pkg_resources."
+ % (name, imp_ver, imp_loc))
+ continue
pr_ver, pr_loc = pkg_resources_vers_and_locs[name]
+ if imp_ver is None and imp_loc is None:
+ errors.append("Warning: dependency %r could not be imported. pkg_resources thought it should be possible "
+ "to import version %r from %r.\nThe exception trace was %r."
+ % (name, pr_ver, pr_loc, imp_comment))
+ continue
+
try:
pr_normver = normalized_version(pr_ver)
except Exception, e:
- errors.append("Warning: version number %s found for dependency %s by pkg_resources could not be parsed. "
- "The version found by import was %s from %r. "
+ errors.append("Warning: version number %r found for dependency %r by pkg_resources could not be parsed. "
+ "The version found by import was %r from %r. "
"pkg_resources thought it should be found at %r. "
"The exception was %s: %s"
- % (pr_ver, name, imp_ver, imp_loc, pr_loc, e.__class__.name, e))
+ % (pr_ver, name, imp_ver, imp_loc, pr_loc, e.__class__.__name__, e))
else:
if imp_ver == 'unknown':
if name not in not_import_versionable:
- errors.append("Warning: unexpectedly could not find a version number for dependency %s imported from %r. "
- "pkg_resources thought it should be version %s at %r."
+ errors.append("Warning: unexpectedly could not find a version number for dependency %r imported from %r. "
+ "pkg_resources thought it should be version %r at %r."
% (name, imp_loc, pr_ver, pr_loc))
else:
try:
imp_normver = normalized_version(imp_ver)
except Exception, e:
- errors.append("Warning: version number %s found for dependency %s (imported from %r) could not be parsed. "
- "pkg_resources thought it should be version %s at %r. "
+ errors.append("Warning: version number %r found for dependency %r (imported from %r) could not be parsed. "
+ "pkg_resources thought it should be version %r at %r. "
"The exception was %s: %s"
- % (imp_ver, name, imp_loc, pr_ver, pr_loc, e.__class__.name, e))
+ % (imp_ver, name, imp_loc, pr_ver, pr_loc, e.__class__.__name__, e))
else:
if pr_ver == 'unknown' or (pr_normver != imp_normver):
if not os.path.normpath(os.path.realpath(pr_loc)) == os.path.normpath(os.path.realpath(imp_loc)):
- errors.append("Warning: dependency %s found to have version number %s (normalized to %s, from %r) "
- "by pkg_resources, but version %s (normalized to %s, from %r) by import."
+ errors.append("Warning: dependency %r found to have version number %r (normalized to %r, from %r) "
+ "by pkg_resources, but version %r (normalized to %r, from %r) by import."
% (name, pr_ver, str(pr_normver), pr_loc, imp_ver, str(imp_normver), imp_loc))
- imported_packages = set([p.lower() for (p, _) in _vers_and_locs_list])
+ imported_packages = set([p.lower() for (p, _) in imported_vers_and_locs_list])
+ extra_vers_and_locs_list = []
for pr_name, (pr_ver, pr_loc) in pkg_resources_vers_and_locs.iteritems():
if pr_name not in imported_packages and pr_name not in ignorable:
- errors.append("Warning: dependency %s (version %s) found by pkg_resources not found by import."
- % (pr_name, pr_ver))
+ extra_vers_and_locs_list.append( (pr_name, (pr_ver, pr_loc, "according to pkg_resources")) )
- return errors
+ return errors, extra_vers_and_locs_list
def get_error_string(errors, debug=False):
errors = []
- # we require 2.4.4 on non-UCS-2, non-Redhat builds to avoid <http://www.python.org/news/security/PSF-2006-001/>
- # we require 2.4.3 on non-UCS-2 Redhat, because 2.4.3 is common on Redhat-based distros and will have patched the above bug
- # we require at least 2.4.2 in any case to avoid a bug in the base64 module: <http://bugs.python.org/issue1171487>
- if sys.maxunicode == 65535:
- if sys.version_info < (2, 4, 2) or sys.version_info[0] > 2:
- errors.append("Tahoe-LAFS current requires Python v2.4.2 or greater "
- "for a UCS-2 build (but less than v3), not %r" %
- (sys.version_info,))
- elif platform.platform().lower().find('redhat') >= 0:
- if sys.version_info < (2, 4, 3) or sys.version_info[0] > 2:
- errors.append("Tahoe-LAFS current requires Python v2.4.3 or greater "
- "on Redhat-based distributions (but less than v3), not %r" %
- (sys.version_info,))
- else:
- if sys.version_info < (2, 4, 4) or sys.version_info[0] > 2:
- errors.append("Tahoe-LAFS current requires Python v2.4.4 or greater "
- "for a non-UCS-2 build (but less than v3), not %r" %
- (sys.version_info,))
+ # We require at least 2.6 on all platforms.
+ # (On Python 3, we'll have failed long before this point.)
+ if sys.version_info < (2, 6):
+ try:
+ version_string = ".".join(map(str, sys.version_info))
+ except Exception:
+ version_string = repr(sys.version_info)
+ errors.append("Tahoe-LAFS currently requires Python v2.6 or greater (but less than v3), not %s"
+ % (version_string,))
vers_and_locs = dict(_vers_and_locs_list)
for requirement in install_requires:
try:
check_requirement(requirement, vers_and_locs)
- except Exception, e:
+ except (ImportError, PackagingError), e:
errors.append("%s: %s" % (e.__class__.__name__, e))
if errors:
def get_package_versions():
- return dict([(k, v) for k, (v, l) in _vers_and_locs_list])
+ return dict([(k, v) for k, (v, l, c) in _vers_and_locs_list])
def get_package_locations():
- return dict([(k, l) for k, (v, l) in _vers_and_locs_list])
+ return dict([(k, l) for k, (v, l, c) in _vers_and_locs_list])
def get_package_versions_string(show_paths=False, debug=False):
+ errors = []
+ if not hasattr(sys, 'frozen'):
+ global _vers_and_locs_list
+ errors, extra_vers_and_locs_list = cross_check_pkg_resources_versus_import()
+ _vers_and_locs_list += extra_vers_and_locs_list
+
res = []
- for p, (v, loc) in _vers_and_locs_list:
+ for p, (v, loc, comment) in _vers_and_locs_list:
info = str(p) + ": " + str(v)
+ if comment:
+ info = info + " [%s]" % str(comment)
if show_paths:
info = info + " (%s)" % str(loc)
res.append(info)
- output = ",\n".join(res) + "\n"
+ output = "\n".join(res) + "\n"
- if not hasattr(sys, 'frozen'):
- errors = cross_check_pkg_resources_versus_import()
- if errors:
- output += get_error_string(errors, debug=debug)
+ if errors:
+ output += get_error_string(errors, debug=debug)
return output