~drizzle-trunk/drizzle/development

#!/usr/bin/python

#  Copyright (C) 2009 Sun Microsystems

#

#  This program is free software; you can redistribute it and/or modify

#  it under the terms of the GNU General Public License as published by

#  the Free Software Foundation; version 2 of the License.

#

#  This program 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 General Public License for more details.

#

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

#  along with this program; if not, write to the Free Software

#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

# Find plugins in the tree and add them to the build system 

import ConfigParser, os, sys

import datetime, time

top_srcdir='.'

top_builddir='.'

plugin_ini_fname='plugin.ini'

plugin_list=[]

plugin_am_file=None

plugin_ac_file=None

class ChangeProtectedFile(object):

  def __init__(self, fname):

    self.bogus_file= False

    self.real_fname= fname

    self.new_fname= "%s.new" % fname

    try:

      self.new_file= open(self.new_fname,'w+')

    except IOError:

      self.bogus_file= True

  def write(self, text):

    if not self.bogus_file:

      self.new_file.write(text)

  # We've written all of this out into .new files, now we only copy them

  # over the old ones if they are different, so that we don't cause 

  # unnecessary recompiles

  def close(self):

    """Return True if the file had changed."""

    if self.bogus_file:

      return

    self.new_file.seek(0)

    new_content = self.new_file.read()

    self.new_file.close()

    try:

        old_file = file(self.real_fname, 'r')

        old_content = old_file.read()

        old_file.close()

    except IOError:

        old_content = None

    if new_content != old_content:

      if old_content != None:

        os.unlink(self.real_fname)

      os.rename(self.new_fname, self.real_fname)

      return True

    else:

        try:

          os.unlink(self.new_fname)

        except:

          pass

def write_external_configure(plugin, plugin_file):

  """Write the initial bits of the configure.ac file"""

  if not os.path.exists('m4'):

    os.mkdir('m4')

  plugin_file.write("""

AC_PREREQ(2.59)dnl		Minimum Autoconf version required.

AC_INIT([%(name)s],[%(version)s],[%(url)s])

AC_CONFIG_SRCDIR([%(main_source)s])

AC_CONFIG_AUX_DIR(config)

AC_CONFIG_HEADERS([config.h])

AC_CONFIG_MACRO_DIR([m4])

PANDORA_CANONICAL_TARGET(less-warnings, warnings-always-on, require-cxx, force-gcc42,skip-visibility)

PANDORA_REQUIRE_LIBPROTOBUF

PANDORA_PROTOBUF_REQUIRE_VERSION([2.1.0])

PANDORA_REQUIRE_PROTOC

AC_LANG_PUSH(C++)

PANDORA_REQUIRE_PTHREAD

PANDORA_REQUIRE_LIBDL

AC_LANG_POP

PANDORA_USE_BETTER_MALLOC

PANDORA_DRIZZLE_BUILD

""" % plugin)

  write_plugin_ac(plugin, plugin_file)

  plugin_file.write("""

AC_CONFIG_FILES(Makefile)

AC_OUTPUT

echo "---"

echo "Configuration summary for $PACKAGE_NAME version $VERSION $PANDORA_RELEASE_COMMENT"

echo ""

echo "   * Installation prefix:       $prefix"

echo "   * System type:               $host_vendor-$host_os"

echo "   * Host CPU:                  $host_cpu"

echo "   * C Compiler:                $CC_VERSION"

echo "   * C++ Compiler:              $CXX_VERSION"

echo "   * Debug enabled:             $with_debug"

echo "   * Warnings as failure:       $ac_cv_warnings_as_errors"

echo "   * C++ cstdint location:      $ac_cv_cxx_cstdint"

echo "   * C++ hash_map location:     $ac_cv_cxx_hash_map"

echo "   * C++ hash namespace:        $ac_cv_cxx_hash_namespace"

echo "   * C++ shared_ptr namespace:  $ac_cv_shared_ptr_namespace"

echo ""

echo "---"

  """ % plugin)

def write_external_makefile(plugin, plugin_file):

  plugin_file.write("""

ACLOCAL_AMFLAGS = -I m4 --force

VERSION=$(PANDORA_RELEASE_VERSION)

pkgplugindir=$(libdir)/drizzle/plugin

EXTRA_DIST = plugin.ini

""" % plugin)

  if plugin['headers'] != "":

    plugin_file.write("noinst_HEADERS = %(headers)s\n" % plugin)

  if plugin['testsuite']:

    if plugin.has_key('testsuitedir') and plugin['testsuitedir'] != "":

      plugin_file.write("EXTRA_DIST += %(testsuitedir)s\n" % plugin)

  plugin_file.write("""

pkgplugin_LTLIBRARIES=lib%(name)s_plugin.la

lib%(name)s_plugin_la_LDFLAGS=-module -avoid-version -rpath $(pkgplugindir) $(AM_LDFLAGS) %(ldflags)s $(GCOV_LIBS)

lib%(name)s_plugin_la_LIBADD=%(libs)s

lib%(name)s_plugin_la_DEPENDENCIES=%(libs)s

lib%(name)s_plugin_la_CPPFLAGS=$(AM_CPPFLAGS) -DPANDORA_DYNAMIC_PLUGIN -DPANDORA_MODULE_NAME=%(name)s -DPANDORA_MODULE_AUTHOR="%(author)s" -DPANDORA_MODULE_TITLE="%(title)s" -DPANDORA_MODULE_VERSION="%(version)s" -DPANDORA_MODULE_LICENSE=%(license)s %(cppflags)s

lib%(name)s_plugin_la_CXXFLAGS=$(AM_CXXFLAGS) %(cxxflags)s

lib%(name)s_plugin_la_CFLAGS=$(AM_CFLAGS) %(cflags)s

lib%(name)s_plugin_la_SOURCES=%(sources)s

""" % plugin)

  plugin_am_file=os.path.join(plugin['rel_path'],'plugin.am')

  if os.path.exists(plugin_am_file):

    plugin_file.write('include %s\n' % plugin_am_file)

def write_external_plugin():

  """Return True if the plugin had changed."""

  plugin = read_plugin_ini('.')

  expand_plugin_ini(plugin, '.')

  plugin_file = ChangeProtectedFile('configure.ac')

  write_external_configure(plugin, plugin_file)

  result = plugin_file.close()

  plugin_file = ChangeProtectedFile('Makefile.am')

  write_external_makefile(plugin, plugin_file)

  # Write some stub configure.ac and Makefile.am files that include the above

  result = plugin_file.close() or result

  return result

def write_plugin(plugin_dir):

  """Return True if the plugin had changed."""

  plugin = read_plugin_ini(plugin_dir)

  expand_plugin_ini(plugin, plugin_dir)

  write_plugin_ac(plugin, plugin_ac_file)

  write_plugin_am(plugin, plugin_am_file)

def write_plugin_ac(plugin, plugin_ac):

  #

  # Write plugin config instructions into plugin.ac file.

  #

  plugin_ac_file=os.path.join(plugin['rel_path'],'plugin.ac')

  plugin_m4_dir=os.path.join(plugin['rel_path'],'m4')

  plugin_m4_files=[]

  if os.path.exists(plugin_m4_dir) and os.path.isdir(plugin_m4_dir):

    for m4_file in os.listdir(plugin_m4_dir):

      if os.path.splitext(m4_file)[-1] == '.m4':

        plugin_m4_files.append(os.path.join(plugin['rel_path'], m4_file))

  plugin_ac.write("""

dnl Config for %(title)s

""" % plugin)

  for m4_file in plugin_m4_files:

    plugin_ac.write('m4_sinclude([%s])\n' % m4_file)

  plugin['plugin_dep_libs']=" ".join(["\${top_builddir}/%s" % f for f in plugin['libs'].split()])

  if plugin['static']:

    plugin_ac.write("""

dnl This plugin is staticly built, which means we cannot live without and it is not

dnl possible to disable it. Once it is disableable, we will make it non-static.

with_%(name)s_plugin=yes

pandora_builtin_list="_drizzled_%(name)s_plugin_,${pandora_builtin_list}"

pandora_plugin_libs="${pandora_plugin_libs} \${top_builddir}/plugin/lib%(name)s_plugin.la"

PANDORA_PLUGIN_DEP_LIBS="${PANDORA_PLUGIN_DEP_LIBS} %(plugin_dep_libs)s"

""" % plugin)

    if plugin['testsuite']:

      plugin_ac.write("""

pandora_plugin_test_list="%(name)s,${pandora_plugin_test_list}"

""" % plugin)

  else:

    plugin_ac.write("""

AC_ARG_WITH([%(name_with_dashes)s-plugin],[

dnl indented wierd to make the help output correct

AS_HELP_STRING([--with-%(name_with_dashes)s-plugin],[Build %(title)s. @<:@default=yes@:>@])

AS_HELP_STRING([--without-%(name_with_dashes)s-plugin],[Disable building %(title)s])

  ],[

    with_%(name)s_plugin="$withval"

    requested_%(name)s_plugin="yes"

  ],[

    with_%(name)s_plugin="yes"

    requested_%(name)s_plugin="no"

  ])

AC_ARG_ENABLE([%(name_with_dashes)s-plugin],[

dnl indented wierd to make the help output correct

AS_HELP_STRING([--enable-%(name_with_dashes)s-plugin],[Build %(title)s. @<:@default=%(default_yesno)s@:>@])

AS_HELP_STRING([--disable-%(name_with_dashes)s-plugin],[Disable building %(title)s])

  ],

  [enable_%(name)s_plugin="$withval"],

  [enable_%(name)s_plugin=%(default_yesno)s])

""" % plugin)

  if os.path.exists(plugin_ac_file):

    plugin_ac.write('m4_sinclude([%s])\n' % plugin_ac_file) 

  # The plugin author has specified some check to make to determine

  # if the plugin can be built. If the plugin is turned on and this 

  # check fails, then configure should error out. If the plugin is not

  # turned on, then the normal conditional build stuff should just let

  # it silently not build

  if plugin['has_build_conditional']:

    plugin_ac.write("""

AS_IF([test %(build_conditional)s],

      [], dnl build_conditional can only negate

      [

        AS_IF([test "x${requested_%(name)s_plugin}" = "xyes"],

              [AC_MSG_ERROR([Plugin %(name)s was explicitly requested, yet failed build dependency checks. Aborting!])])

        with_%(name)s_plugin=no

      ])

""" % plugin)

  if not plugin['unconditional']:

    plugin_ac.write("""

AM_CONDITIONAL([%(build_conditional_tag)s],

               [test %(build_conditional)s])

    """ % plugin)

  if not plugin['static']:

    plugin_ac.write("""

AS_IF([test "x$with_%(name)s_plugin" = "xyes"],

      [

""" % plugin)

    if plugin['testsuite']:

      plugin_ac.write("""

        pandora_plugin_test_list="%(name)s,${pandora_plugin_test_list}"

      """ % plugin)

    plugin_ac.write("""

        AS_IF([test "x$enable_%(name)s_plugin" = "xyes"],[

          pandora_default_plugin_list="%(name)s,${pandora_default_plugin_list}"

        ])

    """ % plugin)

    plugin_ac.write("      ])\n")

def expand_plugin_ini(plugin, plugin_dir):

    if plugin_dir == ".":

      plugin['rel_path']= plugin_dir

      plugin['unconditional']=True

    else:

      plugin['rel_path']= plugin_dir[len(top_srcdir)+len(os.path.sep):]

      plugin['unconditional']=False

    # TODO: determine path to plugin dir relative to top_srcdir... append it to

    # source files if they don't already have it

    if plugin['sources'] == "":

      plugin['sources']="%s.cc" % plugin['name']

    new_sources=""

    if plugin_dir != ".":

      for src in plugin['sources'].split():

        if not src.startswith(plugin['rel_path']):

          src= os.path.join(plugin['rel_path'], src)

          new_sources= "%s %s" % (new_sources, src)

      if new_sources != "":

        plugin['sources']= new_sources

    plugin['main_source']= plugin['sources'].split()[0]

    if plugin_dir != ".":

      new_headers=""

      for header in plugin['headers'].split():

        if not header.startswith(plugin['rel_path']):

          header= os.path.join(plugin['rel_path'], header)

          new_headers= "%s %s" % (new_headers, header)

      plugin['headers']= new_headers

    # Make a yes/no version for autoconf help messages

    if plugin['load_by_default']:

      plugin['default_yesno']="yes"

    else:

      plugin['default_yesno']="no"

    plugin['build_conditional_tag']= "BUILD_%s_PLUGIN" % plugin['name'].upper()

    plugin['name_with_dashes']= plugin['name'].replace('_','-')

    if plugin.has_key('build_conditional'):

      plugin['has_build_conditional']=True

    else:

      plugin['has_build_conditional']=False

      plugin['build_conditional']='"x${with_%(name)s_plugin}" = "xyes"' %plugin

def find_testsuite(plugin_dir):

  for testdir in ['drizzle-tests','tests']:

    if os.path.isdir(os.path.join(plugin_dir,testdir)):

      return testdir

  if os.path.isdir(os.path.join('tests','suite',os.path.basename(plugin_dir))):

    return ""

  return None

def read_plugin_ini(plugin_dir):

    plugin_file= os.path.join(plugin_dir,plugin_ini_fname)

    plugin_defaults= dict(sources="",

                          headers="",

                          cflags="",

                          cppflags="",

                          cxxflags="",

                          libs="",

                          ldflags="",

                          author="",

                          title="",

                          description="",

                          license="PLUGIN_LICENSE_GPL",

                          name=os.path.basename(plugin_dir),

                          load_by_default="False",

                          static="False")

    parser=ConfigParser.ConfigParser(defaults= plugin_defaults)

    parser.read(plugin_file)

    plugin=dict(parser.items('plugin'))

    if plugin_dir == '.':

      if not plugin.has_key('url'):

        print "External Plugins are required to specifiy a url"

        plugin['url']= 'http://launchpad.net/%(name)s' % plugin

        sys.exit(1)

      if plugin_dir == '.' and not plugin.has_key('version'):

        print "External Plugins are required to specifiy a version"

        sys.exit(1)

    if not plugin.has_key('version'):

      plugin['version']=datetime.date.fromtimestamp(time.time()).isoformat()

    if plugin.has_key('load_by_default'):

      plugin['load_by_default']=parser.getboolean('plugin','load_by_default')

    if plugin.has_key('static'):

      plugin['static']= parser.getboolean('plugin','static')

    if plugin.has_key('testsuite'):

      if plugin['testsuite'] == 'disable':

        plugin['testsuite']= False

    else:

      plugin_testsuite= find_testsuite(plugin_dir)

      plugin['testsuitedir']=plugin_testsuite

      if plugin_testsuite is not None:

        plugin['testsuite']=True

      else:

        plugin['testsuite']=False

    return plugin

def write_plugin_am(plugin, plugin_am):

  """Write an automake fragment for this plugin.

  :param plugin: The plugin dict.

  :param plugin_am: The file to write to.

  """

  # The .plugin.ini.stamp avoids changing the datestamp on plugin.ini which can

  # confuse VCS systems.

  plugin_am.write("""

EXTRA_DIST += %(rel_path)s/plugin.ini

# Prevent errors when a plugin dir is removed

%(rel_path)s/plugin.ini:

""" % plugin)

  if plugin['headers'] != "":

    plugin_am.write("noinst_HEADERS += %(headers)s\n" % plugin)

  if plugin['testsuite']:

    if plugin.has_key('testsuitedir') and plugin['testsuitedir'] != "":

      plugin_am.write("EXTRA_DIST += %(rel_path)s/%(testsuitedir)s\n" % plugin)

  if plugin['static']:

    plugin_am.write("""

plugin_lib%(name)s_dir=${top_srcdir}/%(rel_path)s

EXTRA_DIST += %(rel_path)s/plugin.ini

if %(build_conditional_tag)s

  noinst_LTLIBRARIES+=plugin/lib%(name)s_plugin.la

  plugin_lib%(name)s_plugin_la_LIBADD=%(libs)s

  plugin_lib%(name)s_plugin_la_DEPENDENCIES=%(libs)s

  plugin_lib%(name)s_plugin_la_LDFLAGS=$(AM_LDFLAGS) %(ldflags)s $(GCOV_LIBS)  

  plugin_lib%(name)s_plugin_la_CPPFLAGS=$(AM_CPPFLAGS) -DPANDORA_MODULE_NAME=%(name)s -DPANDORA_MODULE_AUTHOR="%(author)s" -DPANDORA_MODULE_TITLE="%(title)s" -DPANDORA_MODULE_VERSION="%(version)s" -DPANDORA_MODULE_LICENSE=%(license)s %(cppflags)s

  plugin_lib%(name)s_plugin_la_CXXFLAGS=$(AM_CXXFLAGS) %(cxxflags)s

  plugin_lib%(name)s_plugin_la_CFLAGS=$(AM_CFLAGS) %(cflags)s

  plugin_lib%(name)s_plugin_la_SOURCES=%(sources)s

  PANDORA_DYNAMIC_LDADDS+=${top_builddir}/plugin/lib%(name)s_plugin.la

endif

""" % plugin)

  else:

    plugin_am.write("""

plugin_lib%(name)s_dir=${top_srcdir}/%(rel_path)s

EXTRA_DIST += %(rel_path)s/plugin.ini

if %(build_conditional_tag)s

  pkgplugin_LTLIBRARIES+=plugin/lib%(name)s_plugin.la

  plugin_lib%(name)s_plugin_la_LDFLAGS=-module -avoid-version -rpath $(pkgplugindir) $(AM_LDFLAGS) %(ldflags)s $(GCOV_LIBS)

  plugin_lib%(name)s_plugin_la_LIBADD=%(libs)s

  plugin_lib%(name)s_plugin_la_DEPENDENCIES=%(libs)s

  plugin_lib%(name)s_plugin_la_CPPFLAGS=$(AM_CPPFLAGS) -DPANDORA_DYNAMIC_PLUGIN -DPANDORA_MODULE_NAME=%(name)s -DPANDORA_MODULE_AUTHOR="%(author)s" -DPANDORA_MODULE_TITLE="%(title)s" -DPANDORA_MODULE_VERSION="%(version)s" -DPANDORA_MODULE_LICENSE=%(license)s %(cppflags)s

  plugin_lib%(name)s_plugin_la_CXXFLAGS=$(AM_CXXFLAGS) %(cxxflags)s

  plugin_lib%(name)s_plugin_la_CFLAGS=$(AM_CFLAGS) %(cflags)s

  plugin_lib%(name)s_plugin_la_SOURCES=%(sources)s

endif

""" % plugin)

  plugin_am_file=os.path.join(plugin['rel_path'],'plugin.am')

  if os.path.exists(plugin_am_file):

    plugin_am.write('include %s\n' % plugin_am_file)

#MAIN STARTS HERE:

actions=[]

for arg in sys.argv:

  if arg.startswith('--top_srcdir='):

    top_srcdir=arg[12:]

  elif arg.startswith('--top_builddir='):

    top_builddir=arg[14:]

  elif arg == "--force-all":

    actions=['plugin-list','pandora-plugin.am','write']

    break

  else:

    actions.append(arg)

if len(actions) == 0:

  actions.append('write')

def accumulate_plugins(arg, dirname, fnames):

  # plugin_ini_fname is a name in dirname indicating dirname is a plugin.

  if plugin_ini_fname in fnames:

    arg.append(dirname)

os.path.walk(os.path.join(top_srcdir,"plugin"),accumulate_plugins,plugin_list)

if not os.path.exists("config/pandora-plugin.am") or "write" in actions:

  plugin_am_file = ChangeProtectedFile(os.path.join('config', 'pandora-plugin.am'))

  plugin_am_file.write("""

# always the current list, generated every build so keep this lean.

# pandora-plugin.list: datestamp preserved list

${srcdir}/config/pandora-plugin.list: .plugin.scan

.plugin.scan:

	@cd ${top_srcdir} && python config/pandora-plugin plugin-list

# Plugins affect configure; so to prevent configure running twice in a tarball

# build (once up front, once with the right list of plugins, we ship the

# generated list of plugins and the housekeeping material for that list so it

# is likewise not updated.

EXTRA_DIST += \

	config/pandora-plugin.am \

	config/pandora-plugin.ac \

	config/pandora-plugin

# Seed the list of plugin LDADDS which plugins may extend.

PANDORA_DYNAMIC_LDADDS=

# plugin.stamp: graph dominator for creating all per pandora-plugin.ac/am

# files. This is invoked when the code to generate such files has altered.""")

if not os.path.exists("config/pandora-plugin.ac") or "write" in actions:

  plugin_ac_file = ChangeProtectedFile(os.path.join('config', 'pandora-plugin.ac'))

  plugin_ac_file.write("dnl Generated file, run make to rebuild\n")

if os.path.exists('plugin.ini'):

  # Are we in a plugin dir which wants to have a self-sufficient build system?

  plugin_list=['.']

  write_external_plugin()

else:

  plugin_list_file = ChangeProtectedFile(os.path.join('config', 'pandora-plugin.list'))

  for p in plugin_list:

    plugin_list_file.write(p)

    plugin_list_file.write("\n")

  plugin_list.sort()

  plugin_list_file.close()

if not os.path.exists("config/pandora-plugin.am") or 'write' in actions:

  plugin_am_file.write("\n${top_srcdir}/config/pandora-plugin.am: ${top_srcdir}/config/pandora-plugin.list ${top_srcdir}/config/pandora-plugin ")

  for plugin_dir in plugin_list:

    plugin_am_file.write("\\\n\t%s/plugin.ini " % plugin_dir)

  plugin_am_file.write("\n\tcd ${top_srcdir} && python config/pandora-plugin write\n")

  for plugin_dir in plugin_list:

    write_plugin(plugin_dir)

if plugin_am_file is not None:

  plugin_am_file.close()

if plugin_ac_file is not None:

  plugin_ac_file.close()