#!/usr/bin/env python

# pylint: disable=W0142,W0403,W0404,W0613,W0622,W0622,W0704,R0904,C0103,E0611

#

# copyright 2003-2011 LOGILAB S.A. (Paris, FRANCE), all rights reserved.

# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr

#

# This file is part of CubicWeb.

#

# CubicWeb is free software: you can redistribute it and/or modify it under the

# terms of the GNU Lesser General Public License as published by the Free

# Software Foundation, either version 2.1 of the License, or (at your option)

# any later version.

#

# CubicWeb is distributed in the hope that it will be useful, but WITHOUT

# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS

# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more

# details.

#

# You should have received a copy of the GNU Lesser General Public License along

# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.

"""Generic Setup script, takes package info from __pkginfo__.py file

"""

import os

import sys

import shutil

from os.path import isdir, exists, join, walk

try:

    if os.environ.get('NO_SETUPTOOLS'):

        raise ImportError() # do as there is no setuptools

    from setuptools import setup

    from setuptools.command import install_lib

    USE_SETUPTOOLS = True

except ImportError:

    from distutils.core import setup

    from distutils.command import install_lib

    USE_SETUPTOOLS = False

from distutils.command import install_data

# import required features

from __pkginfo__ import modname, version, license, description, web, \

     author, author_email

long_description = open('README').read()

# import optional features

import __pkginfo__

if USE_SETUPTOOLS:

    requires = {}

    for entry in ("__depends__",): # "__recommends__"):

        requires.update(getattr(__pkginfo__, entry, {}))

    install_requires = [("%s %s" % (d, v and v or "")).strip()

                       for d, v in requires.items()]

else:

    install_requires = []

distname = getattr(__pkginfo__, 'distname', modname)

scripts = getattr(__pkginfo__, 'scripts', ())

include_dirs = getattr(__pkginfo__, 'include_dirs', ())

data_files = getattr(__pkginfo__, 'data_files', None)

subpackage_of = getattr(__pkginfo__, 'subpackage_of', None)

ext_modules = getattr(__pkginfo__, 'ext_modules', None)

package_data = getattr(__pkginfo__, 'package_data', {})

BASE_BLACKLIST = ('CVS', 'dist', 'build', '__buildlog')

IGNORED_EXTENSIONS = ('.pyc', '.pyo', '.elc')

def ensure_scripts(linux_scripts):

    """

    Creates the proper script names required for each platform

    (taken from 4Suite)

    """

    from distutils import util

    if util.get_platform()[:3] == 'win':

        scripts_ = [script + '.bat' for script in linux_scripts]

    else:

        scripts_ = linux_scripts

    return scripts_

def get_packages(directory, prefix):

    """return a list of subpackages for the given directory

    """

    result = []

    for package in os.listdir(directory):

        absfile = join(directory, package)

        if isdir(absfile):

            if exists(join(absfile, '__init__.py')) or \

                   package in ('test', 'tests'):

                if prefix:

                    result.append('%s.%s' % (prefix, package))

                else:

                    result.append(package)

                result += get_packages(absfile, result[-1])

    return result

def export(from_dir, to_dir,

           blacklist=BASE_BLACKLIST,

           ignore_ext=IGNORED_EXTENSIONS,

           verbose=True):

    """make a mirror of from_dir in to_dir, omitting directories and files

    listed in the black list

    """

    def make_mirror(arg, directory, fnames):

        """walk handler"""

        for norecurs in blacklist:

            try:

                fnames.remove(norecurs)

            except ValueError:

                pass

        for filename in fnames:

            # don't include binary files

            if filename[-4:] in ignore_ext:

                continue

            if filename[-1] == '~':

                continue

            src = '%s/%s' % (directory, filename)

            dest = to_dir + src[len(from_dir):]

            if verbose:

               sys.stderr.write('%s -> %s\n' % (src, dest))

            if os.path.isdir(src):

                if not exists(dest):

                    os.mkdir(dest)

            else:

                if exists(dest):

                    os.remove(dest)

                shutil.copy2(src, dest)

    try:

        os.mkdir(to_dir)

    except OSError as ex:

        # file exists ?

        import errno

        if ex.errno != errno.EEXIST:

            raise

    walk(from_dir, make_mirror, None)

EMPTY_FILE = '"""generated file, don\'t modify or your data will be lost"""\n'

class MyInstallLib(install_lib.install_lib):

    """extend install_lib command to handle  package __init__.py and

    include_dirs variable if necessary

    """

    def run(self):

        """overridden from install_lib class"""

        install_lib.install_lib.run(self)

        # create Products.__init__.py if needed

        if subpackage_of:

            product_init = join(self.install_dir, subpackage_of, '__init__.py')

            if not exists(product_init):

                self.announce('creating %s' % product_init)

                stream = open(product_init, 'w')

                stream.write(EMPTY_FILE)

                stream.close()

        # manually install included directories if any

        if include_dirs:

            if subpackage_of:

                base = join(subpackage_of, modname)

            else:

                base = modname

            for directory in include_dirs:

                dest = join(self.install_dir, base, directory)

                export(directory, dest, verbose=False)

# write required share/cubicweb/cubes/__init__.py

class MyInstallData(install_data.install_data):

    """A class That manages data files installation"""

    def run(self):

        """overridden from install_data class"""

        install_data.install_data.run(self)

        path = join(self.install_dir, 'share', 'cubicweb', 'cubes', '__init__.py')

        ini = open(path, 'w')

        ini.write('# Cubicweb cubes directory\n')

        ini.close()

# re-enable copying data files in sys.prefix

if USE_SETUPTOOLS:

    # overwrite MyInstallData to use sys.prefix instead of the egg directory

    MyInstallMoreData = MyInstallData

    class MyInstallData(MyInstallMoreData): # pylint: disable=E0102

        """A class that manages data files installation"""

        def run(self):

            _old_install_dir = self.install_dir

            if self.install_dir.endswith('egg'):

                self.install_dir = sys.prefix

            MyInstallMoreData.run(self)

            self.install_dir = _old_install_dir

    try:

        import setuptools.command.easy_install # only if easy_install available

        # monkey patch: Crack SandboxViolation verification

        from setuptools.sandbox import DirectorySandbox as DS

        old_ok = DS._ok

        def _ok(self, path):

            """Return True if ``path`` can be written during installation."""

            out = old_ok(self, path) # here for side effect from setuptools

            realpath = os.path.normcase(os.path.realpath(path))

            allowed_path = os.path.normcase(sys.prefix)

            if realpath.startswith(allowed_path):

                out = True

            return out

        DS._ok = _ok

    except ImportError:

        pass

def install(**kwargs):

    """setup entry point"""

    if USE_SETUPTOOLS:

        if '--force-manifest' in sys.argv:

            sys.argv.remove('--force-manifest')

    # install-layout option was introduced in 2.5.3-1~exp1

    elif sys.version_info < (2, 5, 4) and '--install-layout=deb' in sys.argv:

        sys.argv.remove('--install-layout=deb')

    if subpackage_of:

        package = subpackage_of + '.' + modname

        kwargs['package_dir'] = {package : '.'}

        packages = [package] + get_packages(os.getcwd(), package)

        if USE_SETUPTOOLS:

            kwargs['namespace_packages'] = [subpackage_of]

    else:

        kwargs['package_dir'] = {modname : '.'}

        packages = [modname] + get_packages(os.getcwd(), modname)

    if USE_SETUPTOOLS:

        kwargs['install_requires'] = install_requires

        kwargs['zip_safe'] = False

    kwargs['packages'] = packages

    kwargs['package_data'] = package_data

    return setup(name=distname, version=version, license=license, url=web,

                 description=description, long_description=long_description,

                 author=author, author_email=author_email,

                 scripts=ensure_scripts(scripts), data_files=data_files,

                 ext_modules=ext_modules,

                 cmdclass={'install_lib': MyInstallLib,

                           'install_data': MyInstallData},

                 **kwargs

                 )

if __name__ == '__main__' :

    install()