path: root/setup.py

#!/usr/bin/env python

# Copyright (c) 2013-2015, Kevin Greenan (kmgreen2@gmail.com)
# Copyright (c) 2013-2015, Tushar Gohad (tusharsg@gmail.com)
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.  THIS SOFTWARE IS
# PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
# NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import os
import platform
import sys

from distutils.command.build import build as _build
from distutils.command.clean import clean as _clean
from distutils.sysconfig import EXEC_PREFIX as _exec_prefix
from distutils.sysconfig import get_python_lib
from distutils.sysconfig import get_python_inc

try:
    from setuptools import setup
except ImportError:
    from distribute_setup import use_setuptools
    use_setuptools()
    from setuptools import setup

from setuptools import Extension
from setuptools.command.install import install as _install

platform_str = platform.platform()
default_python_incdir = get_python_inc()
default_python_libdir = get_python_lib()

#
# ToDo: Note the hardcoded location of liberasurecode.
# This will be removed once liberasurecode is no longer
# packaged with PyECLib.  This is silly, but we (Kevin
# and Tushar) cannot explain what is going on with
# distutils or libtool here.
#
standard_library_paths = [('%s/usr/local/lib' % _exec_prefix),
                          '/lib', '/usr/lib', '/usr/local/lib']

default_library_paths = [default_python_libdir,
                         ('%s/usr/local/lib' % _exec_prefix),
                         '/lib', '/usr/lib', '/usr/local/lib',
                         'src/c/liberasurecode-1.0.6/src/.libs']

default_include_paths = [default_python_incdir,
                         '/usr/local/include', '/usr/local/include/jerasure',
                         '/usr/include', 'src/c/pyeclib_c',
                         '/usr/local/include']

libflags = ''
includeflags = ''

# utility routines
def _read_file_as_str(name):
    with open(name, "rt") as f:
        s = f.readline().strip()
    return s

def _get_installroot(distribution):
    install_cmd = distribution.get_command_obj('install')
    install_lib = distribution.get_command_obj('install_lib')
    for cmd in (install_lib, install_cmd):
        cmd.ensure_finalized()

    # ensure that the paths are absolute so we don't get lost
    opts = {'exec_prefix': install_cmd.exec_prefix,
            'root': install_cmd.root}
    for optname, value in list(opts.items()):
        if value is not None:
            opts[optname] = os.path.abspath(value)

    prefix = opts['exec_prefix']
    root = opts['root']

    # prefer root for installdir
    if root is not None:
        installroot = root
    elif prefix is not None:
        installroot = prefix
    else:
        installroot = "/"

    # exception is "/usr"
    if installroot.startswith("/usr"):
        installroot = "/"

    return installroot

def _check_library(library, soname, library_url, mode, distribution):
    global libflags
    global includeflags
    missing = True
    library_suffix = ".so"
    if platform_str.find("Darwin") > -1:
        library_suffix = ".dylib"
    library_file = soname + library_suffix
    for dir in (standard_library_paths):
        library_file_path = dir + os.sep + library_file
        if (os.path.isfile(library_file_path)):
            missing = False
            break
    if missing:
        # try using an integrated copy of the library
        srcpath = "src/c/"
        locallibsrcdir = (srcpath + library)
        installroot = _get_installroot(distribution)

        retval = os.system("tar xf %s/%s.tar.gz -C %s" % (srcpath, library, srcpath))

        if (os.path.isdir(locallibsrcdir)):
            # patch default include, lib paths
            topdir = os.getcwd()
            libdirs = [ (topdir + "/" + locallibsrcdir + "/.libs "),
                        (topdir + "/" + locallibsrcdir + "/src/.libs ")] 
            for d in libdirs:
                libflags = libflags + " -L" + d
                default_library_paths.append(d)

            includeflags = includeflags + " -I" + topdir + "/" + locallibsrcdir + "/include"
            for subdir in os.walk(topdir + "/" + locallibsrcdir + "/include"):
                if (os.path.isdir(subdir[0])):
                    includeflags = includeflags + " -I" + subdir[0]
                    default_include_paths.append(subdir[0])

            curdir = os.getcwd()
            os.chdir(locallibsrcdir)
            statefile = "." + library + "_configured"
            if (not os.path.isfile(statefile)):
                configure_cmd = ("CFLAGS=\"%s\" LDFLAGS=\"%s\" " % (includeflags, libflags))
                configure_cmd = ("%s ./configure --prefix=%s/usr/local" % \
                    (configure_cmd, installroot))
                print(configure_cmd)
                retval = os.system(configure_cmd)
                if retval == 0:
                    touch_cmd = ("touch " + statefile)
                    os.system(touch_cmd)
                elif retval != 0:
                    print("***************************************************")
                    print("*** Error: " + library + " build failed!")
                    print("*** Please install " + library + " manually and retry")
                    print("**   " + library_url)
                    print("***************************************************")
                    os.chdir(curdir)
                    sys.exit(retval)
            make_cmd = ("make")
            if mode == "install":
                make_cmd = ("%s && make install" % make_cmd)
            retval = os.system(make_cmd)
            if retval != 0:
                print("***************************************************")
                print("*** Error: " + library + " install failed!")
                print("** Please install " + library + " manually and retry")
                print("**   " + library_url)
                print("***************************************************")
                os.chdir(curdir)
                sys.exit(retval)
            os.chdir(curdir)
        else:
            print("***************************************************")
            print("** Cannot locate the " + library + " library:  ")
            print("**   %s" % (library_file))
            print("**")
            print("** PyECLib requires that " + library)
            print("** library be installed from:")
            print("**   " + library_url)
            print("**")
            print("** Please install " + library + " and try again.")
            print("***************************************************")
            sys.exit(1)


class build(_build):

    def run(self):
        _check_library("liberasurecode-1.0.6", "liberasurecode",
                       "https://bitbucket.org/tsg-/liberasurecode.git",
                       "build", self.distribution)
        _build.run(self)


class clean(_clean):

    def run(self):
        _clean.run(self)


class install(_install):

    def run(self):
        _check_library("liberasurecode-1.0.6", "liberasurecode",
                       "https://bitbucket.org/tsg-/liberasurecode.git",
                       "install", self.distribution)
        _check_library("gf-complete-1.0", "libgf_complete",
                       "http://lab.jerasure.org/jerasure/gf-complete.git",
                       "install", self.distribution)
        _check_library("jerasure-2.0", "libJerasure",
                       "http://lab.jerasure.org/jerasure/jerasure.git",
                       "install", self.distribution)
        installroot = _get_installroot(self.distribution)
        default_library_paths.insert(0, "%s/usr/local/lib" % installroot)
        _install.run(self)

        # Another Mac-ism...  If the libraries are installed
        # in a strange place, DYLD_LIRBARY_PATH needs to be
        # updated.
        if platform_str.find("Darwin") > -1:
            ldpath_str = "DYLD_LIBRARY_PATH"
        else:
            ldpath_str = "LD_LIBRARY_PATH"
        print("***************************************************")
        print("**                                                 ")
        print("** PyECLib libraries have been installed to:       ")
        print("**   %susr/local/lib" % installroot)
        print("**                                                 ")
        print("** Any user using this library must update:        ")
        print("**   %s" % ldpath_str)
        print("**                                                 ")
        print("** Run 'ldconfig' or place this line:              ")
        print("**   export %s=%s" % (ldpath_str, "%susr/local/lib"
                                     % installroot))
        print("**                                                 ")
        print("** into .bashrc, .profile, or the appropriate shell")
        print("** start-up script!  Also look at ldconfig(8) man  ")
        print("** page for a more static LD configuration         ")
        print("**                                                 ")
        print("***************************************************")


module = Extension('pyeclib_c',
                   define_macros=[('MAJOR VERSION', '0'),
                                  ('MINOR VERSION', '9')],
                   include_dirs=default_include_paths,
                   library_dirs=default_library_paths,
                   runtime_library_dirs=default_library_paths,
                   libraries=['erasurecode'],
                   # The extra arguments are for debugging
                   # extra_compile_args=['-g', '-O0'],
                   extra_link_args=['-Wl,-rpath,%s' %
                                    l for l in default_library_paths],
                   sources=['src/c/pyeclib_c/pyeclib_c.c'])

setup(name='PyECLib',
      version='1.0.6',
      author='Kevin Greenan',
      author_email='kmgreen2@gmail.com',
      maintainer='Kevin Greenan and Tushar Gohad',
      maintainer_email='kmgreen2@gmail.com, tusharsg@gmail.com',
      url='https://bitbucket.org/kmgreen2/pyeclib',
      description='This library provides a simple Python interface for \
                   implementing erasure codes.  To obtain the best possible \
                   performance, the underlying erasure code algorithms are \
                   written in C.',
      platforms='Linux',
      license='BSD',
      ext_modules=[module],
      packages=['pyeclib'],
      package_dir={'pyeclib': 'pyeclib'},
      cmdclass={'build': build, 'install': install, 'clean': clean},
      py_modules=['pyeclib.ec_iface', 'pyeclib.core'],
      test_suite='test')