Merge lp:~hingo/drizzle/drizzle-new-pandora-pluginini-keys into lp:~drizzle-trunk/drizzle/development

[Henrik Ingo]

In order to document auth_ldap (part of https://blueprints.launchpad.net/drizzle/+spec/docs71-focus-areas) I ended up doing changes to the build system so that a script and some openldap schema files become part of a make install. This is needed so an end user can get them without downloading Drizzle sources.

This branch contains the change throughout the build system, including classifying the files with new pandora plugin.ini keys so they are installed by make install. This is ready for testing and merging into trunk. We'll work on the documentation in another branch.

More details from the commit message:

This does 2 things:

1) Modify pandora-plugin to allow more keys in a plugin.ini. Until now
you could only specify headers, sources and extra-dist, but not
scripts (that are not compiled, just copied) or various text or data
files you wish to be part of an installation.

The new plugin.ini keys correspond to automake targets as follows:

# plugin.ini key
automake variable
-----------------
# scripts or bin_scripts
dist_bin_SCRIPTS=
# sbin_scripts
dist_sbin_SCRIPTS=
# libexec_scripts
dist_libexec_SCRIPTS=
# pkg_scripts
dist_pkgdata_SCRIPTS=
# data
dist_data_DATA=
# pkg_data
dist_pkgdata_DATA=
# sysconf_data
dist_sysconf_DATA=

2a) Uses the new keys pkg_scripts and pkg_data to move some useful
files from the auth_ldap plugin to ./share/drizzle7/ so an end user
can benefit from them without downloading Drizzle source codes.

2b) Also adds libdrizzle-2.0/libdrizzle/mysql_password_hash to programs
that should be installed and changes the name to drizzle_password_hash.
(Source filenames are unchanged. Makefile first builds mysql_password_hash
and then makes a copy to the final name. I didn't know if someone expects
mysql_password_hash to be there in some tests or something.)

The intent is to write documentation for LDAP authentication that uses
bin/drizzle_password_hash and share/drizzle7/* for creating LDAP user
records.

=== modified file '.bzrignore'
--- .bzrignore	2011-08-04 08:13:04 +0000
+++ .bzrignore	2011-10-04 20:57:25 +0000
@@ -167,6 +167,7 @@
 key.gcno
 key_map.gcno
 libdrizzle-2.0/libdrizzle/mysql_password_hash
+libdrizzle-2.0/libdrizzle/drizzle_password_hash
 libmysql/Makefile.in
 libserialutil_la-db.gcno
 libserialutil_la-unireg.gcno
 
=== modified file 'Makefile.am'
--- Makefile.am	2011-08-16 01:07:54 +0000
+++ Makefile.am	2011-10-04 20:57:25 +0000
@@ -16,14 +16,20 @@
 ACLOCAL_AMFLAGS = -I m4 --force
 
 # includes append to these:
+# Pandora build system takes input from plugin.ini files that are appended to these
+# Corresponding Pandora parameter names are mentioned in comments
+# A few directory targets (libexec/ and etc/) are unused as of this writing and
+# therefore commented out. pandora-build will support them if you uncomment.
 SUFFIXES =
 TESTS =
 check_PROGRAMS =
+# headers
 noinst_HEADERS =
 nobase_nodist_include_HEADERS =
 nobase_dist_include_HEADERS =
 dist_include_HEADERS =
 nobase_nodist_pkginclude_HEADERS =
+# install_headers
 nobase_dist_pkginclude_HEADERS =
 dist_pkginclude_HEADERS =
 sbin_PROGRAMS =
@@ -35,6 +41,21 @@
 man_MANS =
 bin_PROGRAMS =
 
+# scripts or bin_scripts
+dist_bin_SCRIPTS=
+# sbin_scripts
+dist_sbin_SCRIPTS=
+# libexec_scripts
+#dist_libexec_SCRIPTS=
+# pkg_scripts
+dist_pkgdata_SCRIPTS=
+# data
+dist_data_DATA=
+# pkg_data
+dist_pkgdata_DATA=
+# sysconf_data
+#dist_sysconf_DATA=
+
 VERSION=$(PANDORA_RELEASE_VERSION)
 
 SUBDIRS = .
 
=== modified file 'config/pandora-plugin'
--- config/pandora-plugin	2011-02-28 18:00:50 +0000
+++ config/pandora-plugin	2011-10-04 20:57:25 +0000
@@ -365,7 +365,23 @@
 
     if plugin.has_key('extra_dist'):
       plugin['extra_dist']=" ".join([os.path.join(plugin['rel_path'],f) for f in plugin['extra_dist'].split()])
-
+    if plugin.has_key('bin_scripts'):
+      plugin['bin_scripts']=" ".join([os.path.join(plugin['rel_path'],f) for f in plugin['bin_scripts'].split()])
+    if plugin.has_key('scripts'):
+      plugin['scripts']=" ".join([os.path.join(plugin['rel_path'],f) for f in plugin['scripts'].split()])
+    if plugin.has_key('sbin_scripts'):
+      plugin['sbin_scripts']=" ".join([os.path.join(plugin['rel_path'],f) for f in plugin['sbin_scripts'].split()])
+    if plugin.has_key('libexec_scripts'):
+      plugin['libexec_scripts']=" ".join([os.path.join(plugin['rel_path'],f) for f in plugin['libexec_scripts'].split()])
+    if plugin.has_key('pkg_scripts'):
+      plugin['pkg_scripts']=" ".join([os.path.join(plugin['rel_path'],f) for f in plugin['pkg_scripts'].split()])
+    if plugin.has_key('data'):
+      plugin['data']=" ".join([os.path.join(plugin['rel_path'],f) for f in plugin['data'].split()])
+    if plugin.has_key('pkg_data'):
+      plugin['pkg_data']=" ".join([os.path.join(plugin['rel_path'],f) for f in plugin['pkg_data'].split()])
+    if plugin.has_key('sysconf_data'):
+      plugin['sysconf_data']=" ".join([os.path.join(plugin['rel_path'],f) for f in plugin['sysconf_data'].split()])
+    
 
     if plugin['static']:
       plugin['static_yesno']="yes"
@@ -534,6 +550,22 @@
 """ % plugin)
   if plugin.has_key('extra_dist') and plugin['extra_dist'] != "":
     plugin_am.write("EXTRA_DIST += %(extra_dist)s\n" % plugin)
+  if plugin.has_key('bin_scripts') and plugin['bin_scripts'] != "":
+    plugin_am.write("dist_bin_SCRIPTS += %(bin_scripts)s\n" % plugin)
+  if plugin.has_key('scripts') and plugin['scripts'] != "":
+    plugin_am.write("dist_bin_SCRIPTS += %(scripts)s\n" % plugin)
+  if plugin.has_key('sbin_scripts') and plugin['sbin_scripts'] != "":
+    plugin_am.write("dist_sbin_SCRIPTS += %(sbin_scripts)s\n" % plugin)
+  if plugin.has_key('libexec_scripts') and plugin['libexec_scripts'] != "":
+    plugin_am.write("dist_libexec_SCRIPTS += %(libexec_scripts)s\n" % plugin)
+  if plugin.has_key('pkg_scripts') and plugin['pkg_scripts'] != "":
+    plugin_am.write("dist_pkgdata_SCRIPTS += %(pkg_scripts)s\n" % plugin)
+  if plugin.has_key('data') and plugin['data'] != "":
+    plugin_am.write("dist_data_DATA += %(data)s\n" % plugin)
+  if plugin.has_key('pkg_data') and plugin['pkg_data'] != "":
+    plugin_am.write("dist_pkgdata_DATA += %(pkg_data)s\n" % plugin)
+  if plugin.has_key('sysconf_data') and plugin['sysconf_data'] != "":
+    plugin_am.write("dist_sysconf_DATA += %(sysconf_data)s\n" % plugin)
   if plugin['headers'] != "":
     plugin_am.write("noinst_HEADERS += %(headers)s\n" % plugin)
   if plugin['install_headers'] != "":
 
=== modified file 'libdrizzle-2.0/libdrizzle/include.am'
--- libdrizzle-2.0/libdrizzle/include.am	2011-06-15 17:51:40 +0000
+++ libdrizzle-2.0/libdrizzle/include.am	2011-10-04 20:57:25 +0000
@@ -40,11 +40,21 @@
 endif
 
 noinst_PROGRAMS+= \
-		  libdrizzle-2.0/libdrizzle/mysql_password_hash
+                  libdrizzle-2.0/libdrizzle/mysql_password_hash
 libdrizzle_2_0_libdrizzle_mysql_password_hash_CXXFLAGS= ${AM_CXXFLAGS} ${LIBDRIZZLE_CPPFLAGS}
 libdrizzle_2_0_libdrizzle_mysql_password_hash_LDADD= libdrizzle-2.0/libdrizzle/libdrizzle-2.0.la
 libdrizzle_2_0_libdrizzle_mysql_password_hash_SOURCES= libdrizzle-2.0/libdrizzle/mysql_password_hash.cc
 
+# For some reason this has originally been called mysql_password_hash. I'd prefer
+# to call it drizzle_password_hash but to remain backward compatible I didn't
+# change any sources, rather just build it twice and provide both.
+# Only drizzle_password_hash is installed by make install though.
+bin_PROGRAMS+= \
+		  libdrizzle-2.0/libdrizzle/drizzle_password_hash
+libdrizzle_2_0_libdrizzle_drizzle_password_hash_CXXFLAGS= ${AM_CXXFLAGS} ${LIBDRIZZLE_CPPFLAGS}
+libdrizzle_2_0_libdrizzle_drizzle_password_hash_LDADD= libdrizzle-2.0/libdrizzle/libdrizzle-2.0.la
+libdrizzle_2_0_libdrizzle_drizzle_password_hash_SOURCES= libdrizzle-2.0/libdrizzle/mysql_password_hash.cc
+
 noinst_PROGRAMS+= \
 	examples/client \
 	examples/simple \
 
=== modified file 'plugin/auth_ldap/plugin.ini'
--- plugin/auth_ldap/plugin.ini	2010-08-17 20:57:43 +0000
+++ plugin/auth_ldap/plugin.ini	2011-10-04 20:57:25 +0000
@@ -6,8 +6,6 @@
 license=PLUGIN_LICENSE_GPL
 build_conditional="x${ac_cv_libldap}" = "xyes"
 ldflags=${LTLIBLDAP}
-extra_dist=schema/README
- schema/gentestusers.sh
- schema/openldap/drizzle.ldif
- schema/openldap/drizzle.schema
- test_ldap.sh
+pkg_scripts= schema/drizzle_create_ldap_user
+pkg_data= schema/README.auth_ldap schema/openldap/drizzle_openldap.ldif schema/openldap/drizzle_openldap.schema
+extra_dist=test_ldap.sh
 
=== renamed file 'plugin/auth_ldap/schema/README' => 'plugin/auth_ldap/schema/README.auth_ldap'
--- plugin/auth_ldap/schema/README	2010-05-05 20:49:48 +0000
+++ plugin/auth_ldap/schema/README.auth_ldap	2011-10-04 20:57:25 +0000
@@ -13,15 +13,15 @@
 
 Schema and ldif files are located in the server specific directories. 
 
-gentestusers.sh:
+drizzle_create_ldap_user:
 
     This is a script to quickly generate users for testing the drizzle mysql ldap authentication module.  Note this is not the de facto way of doing things more of just a quick start example.
 
-./gentestusers.sh -h 
+./drizzle_create_ldap_user -h 
     This will output help on how to use the file.
 
 Example:
-./gentestusers.sh -p pass -b ../libdrizzle/bin/mysql_password_hash -u user -n 1 -l "ou=people,dc=drizzle,dc=org"
+./drizzle_create_ldap_user -p pass -b <drizzle installdir>/bin/drizzle_password_hash -u user -n 1 -l "ou=people,dc=drizzle,dc=org"
 
 Will output:
 
 
=== renamed file 'plugin/auth_ldap/schema/gentestusers.sh' => 'plugin/auth_ldap/schema/drizzle_create_ldap_user' (properties changed: -x to +x)
=== renamed file 'plugin/auth_ldap/schema/openldap/drizzle.ldif' => 'plugin/auth_ldap/schema/openldap/drizzle_openldap.ldif'
=== renamed file 'plugin/auth_ldap/schema/openldap/drizzle.schema' => 'plugin/auth_ldap/schema/openldap/drizzle_openldap.schema'