source: other-projects/gs3-webservices-java-client/trunk/build.xml@ 26173

<?xml version="1.0"?>
<!-- ====================================================================== 
     April 2008 - GS3 web services democlient compile script
     With lots of help from kjdon's Greenstone3 build and install script
     See http://ant.apache.org/manual/ 
     http://ant.apache.org/manual/usinglist.html
     for info on build.xml ant files,                                                         
     and http://ant.apache.org/manual/coretasklist.html
     http://ant.apache.org/manual/tasksoverview.html
====================================================================== -->
<project name="gs3democlient" default="usage" basedir=".">
<description>This buildfile is used to build the demo-client for Greenstone3's web services.</description>

  <!-- ============ predefining properties for reuse =================== -->
 <property name="src.dir" value="${basedir}/src" />
 <property name="democlient.rootdir" value="${src.dir}/GS3DemoClient" />
 <property name="democlient.src" value="${democlient.rootdir}/org" />
 <property name="fedorags3.rootdir" value="${src.dir}/GS3Fedora" />
 <property name="fedorags3.src" value="${fedorags3.rootdir}/org" />
 <property name="gsearchinstaller.rootdir" value="${src.dir}/GSearchInstaller" />
 <property name="gsearchinstaller.src" value="${gsearchinstaller.rootdir}/org" />

 <property name="build" value="${basedir}/build" />
 <property name="dist" value="${basedir}/dist" />

 <property name="QBRdata.rel.path" value="org/greenstone/gs3client/data" />
 <property name="dlservices.rel.path" value="org/greenstone/gs3client/dlservices" />
 <property name="gui.rel.path" value="org/greenstone/gs3client" />
 <property name="gs3services.rel.path" value="org/greenstone/gs3services" />

 <property name="exec.jar.name" value="GS3democlient.jar" /> <!-- name of the executable-->
 <property name="gs3.files.jar" value="gs3_for_client.jar" />
 <property name="log4j.propFile" value="log4j.properties" />

 <property name="dist.zip.name" value="gs3_webservices_democlient" />
 <property name="zip.excludes" value="dist/**,logs/**,gs3democlient.properties" />
 <property name="dist.dir.name" value="gs3-webservices-democlient" />

 <!-- svn url locations for obtaining copies of the latest version of source code dependencies -->
 <property name="gs3forclient.svn.path" value="http://svn.greenstone.org/main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util"/>
 <property name="check.java.version.svn.file" value="http://svn.greenstone.org/main/trunk/gli/CheckJavaVersion.java"/>

  <!-- ============ project classpath: everything in the lib folder =================== -->
 <path id="project.classpath">
     <fileset dir="lib">
      <include name="**/*.jar"/>
    </fileset>
  </path>

<target name="usage" description="Prints out ant commands for the GS3 demo-client">
    <echo>Type:</echo>
    <echo>- ant build-demo-client</echo>
    <echo>  for (compiling) and creating the demo-client executable</echo>
    <echo>- ant compile-demo-client</echo>
    <echo>  for compiling the democlient</echo>
    <echo>- ant fedoraGS3jar</echo>
    <echo>  for generating the fedoraGS3.jar dependency file</echo>
    <echo>- ant QBRdatajar</echo>
    <echo>  for generating the QBRdata.jar dependency file</echo>
        <echo>- ant DLservicesjar</echo>
    <echo>  for generating the DLservices.jar standalone library</echo>
    <echo>- ant make-dist</echo>
    <echo>  for generating the zip/gzip/bzip file of the project</echo>
    <echo>- ant clean-democlient</echo>
    <echo>  for deleting the *.class files from the GS3democlient's source</echo>
    <echo>- ant clean</echo>
    <echo>  for deleting the *.class files from the GS3democlient and GS3Fedora sources</echo>
    <echo>- ant distclean</echo>
    <echo>  for deleting the *.class files from the sources, the QBRdata.jar, fedoraGS3.jar, executable jar file, and any zips of the project folder</echo> 
        <echo>- ant update</echo> 
        <echo>  for getting the latest version of CheckJavaVersion.java, and the files for creating the gs3_for_client.jar dependency from Greenstone's SVN repository</echo>
    <echo>- ant GSearchInstallerjar</echo> 
        <echo>  for generating the GSearchInstaller.jar application that helps in installing Fedora Generic Search (if you have Fedora installed).</echo>
</target>


<!-- Main targets: to build the GS3 web services demo-client and to create the tar.gz file for downloading -->
<target name="build-demo-client" description="Creates the jar distribution file" depends="compile-demo-client,ensure-check-java-version">
  <mkdir dir="${basedir}/logs" /> <!-- Need a logs dir for outputting log4j stuff-->
  <jar destfile="${exec.jar.name}"
     basedir="${democlient.rootdir}/"
     manifest="Manifest.MF"
     excludes="${QBRdata.rel.path}/*.class"
  />
  <copy file="${src.dir}/${log4j.propFile}" tofile="${basedir}/${log4j.propFile}"/>
<!-- LATER: only for tarring include source files, so that we can exclude the java files in this build?-->
</target>

<target name="make-dist" description="Generates the zip file of the lib and src folders and the executable ${exec.jar.name} file" depends="get-zipformat,ensure-exec-jar,ensure-gsearchinstall-jar" if="zip.type">
   <mkdir dir="${dist}" />
   <antcall target="create-${zip.type}"/>
</target>

<!--
http://ananthkannan.blogspot.com/2009/12/java-exception-unknown-source.html
"Sometimes when debugging application we may run into this exception - Java Exception unknown source.
The possible reason could be when compiling the application, javac ant tasks omits debug option by defaut. So we will have to explicity set debug flag to true. See the javac ant task documentation for more info. You can mention some thing like below:

<target name="compile">
  <javac srcdir="${src.dir}" destdir="{dest.dir}." debug="on" debuglevel="lines,vars,source" />
</target>"
-->

<!-- Compilation first ensures the existence of QBRdata.jar AND fedoraGS3.jar by checking whether these jars already exist and, if not, generating them. It is then that the actual compilation of the GS3democlient starts. By now the QBRdata classes of the GS3democlient src folder would have been compiled, but that does not matter as javac only compiles when class files are outdated or when they have not been generated yet.-->
<target name="compile-demo-client" description="Compiles the GS3 demo-client" depends="ensure-QBRdata-jar,ensure-fedoraGS3-jar,ensure-gs3-for-client">
    <javac srcdir="${democlient.rootdir}" debug="on" debuglevel="lines,vars,source">
      <classpath refid="project.classpath"/>
      <exclude name="${gs3services.rel.path}/**" /> <!--gs3services package needs official gsdl.jar to compile, so we skip it as it is not part of the client anyway-->
    </javac>
</target>

<!-- Cleaning targets -->
<target name="clean-democlient" description="Removes all class files from the GS3demo-client (includes the data package that is used to create QBRdata.jar)">
   <delete>
    <fileset dir="${democlient.src}" includes="**/*.class"/>
   </delete>
</target>

<target name="clean" description="Removes all class files from the GS3DemoClient, GS3Fedora, GSearchInstaller source folders" depends="clean-democlient">
   <delete>
    <fileset dir="${fedorags3.src}" includes="**/*.class"/>
    <fileset dir="${gsearchinstaller.src}" includes="**/*.class"/>
   </delete>
</target>

<target name="distclean" description="Removes the project-specific jars fedoraGS3.jar, QBRdata.jar, ${exec.jar.name} files AND all class files from the GS3DemoClient, GS3Fedora and GSearchInstaller source folders" depends="clean">
   <delete includeEmptyDirs="true" failonerror="false">
    <fileset file="${basedir}/GSearchInstaller.jar"/>
    <fileset file="${basedir}/lib/fedoraGS3.jar"/>
    <fileset file="${basedir}/lib/QBRdata.jar"/>
    <fileset file="${basedir}/lib/DLservices.jar"/>
    <fileset file="${basedir}/${exec.jar.name}"/>
    <fileset file="${basedir}/gs3democlient.properties"/>
    <fileset dir="logs"/>
    <fileset file="${log4j.propFile}"/>
    <fileset file="${dist}/${dist.zip.name}.tar"/>
    <fileset file="${dist}/${dist.zip.name}.tar.gz"/>
    <fileset file="${dist}/${dist.zip.name}.zip"/>
    <fileset file="${dist}/${dist.zip.name}.tar.bz2"/>
   </delete>
</target>

<!-- Targets for updating some source code dependencies from Greenstone SVN -->
<!-- Explicit update of java file dependencies. First make a directory and copy the old files in there (if they are present)-->
<target name="update" description="Gets the latest version of CheckJavaVersion.java, and gs3-client-jar's files from Greenstone's SVN repository">
   <delete>
      <fileset dir="${basedir}" includes="CheckJavaVersion.*"/>
   </delete>
   <antcall target="update-check-java-version" />   
   <antcall target="update-gs3-for-client" />
</target>

<target name="ensure-gs3-for-client" description="Ensures the ${gs3.files.jar} file of required Greenstone3 support files is there">
    <condition property="gs3.for.client.exists">
    <available file="${basedir}/lib/${gs3.files.jar}"/>
    </condition>
    <antcall target="update-gs3-for-client" />
</target>

<target name="ensure-check-java-version" description="Ensures the CheckJavaVersion.java file required to run the demo-client's launching scripts (sh or bat) is present">
    <condition property="check.java.version.exists">
    <and>
    <available file="${basedir}/CheckJavaVersion.class"/>
    <available file="${basedir}/CheckJavaVersion.java"/>
    </and>
    </condition>
    <antcall target="update-check-java-version" />
</target>

<!-- Gets the file if the local copy is missing or out of date (since usetimestamp=true) -->
<target name="update-check-java-version" description="Gets the latest version of CheckJavaVersion.java from Greenstone's SVN repository" unless="check.java.version.exists">
  <get src="${check.java.version.svn.file}" 
    dest="${basedir}/CheckJavaVersion.java"
    usetimestamp="true" />
  <!-- compile it up: specifying the file to be compiled explicitly (sourcepath="")--> 
  <javac sourcepath="" srcdir="${basedir}" destdir="${basedir}" debug="on" debuglevel="lines,vars,source">
    <include name="**/CheckJavaVersion.java"/>
  </javac>
</target>

<target name="update-gs3-for-client" description="Gets the latest version of the files needed to create ${gs3.files.jar} from Greenstone's SVN repository" unless="gs3.for.client.exists">
  <mkdir dir="${basedir}/tmp" />
  <echo>Getting java files GSXML, XMLConverter, GSPath and MyNodeList from Greenstone's SVN repository (${gs3forclient.svn.path}). Compiling and jarring them up into ${gs3.files.jar}...</echo>
  <!-- No point using timestamp here with the get Task, since the tmp file is newly created and will not already have these java files. Get will therefore always retrieve them -->
  <get src="${gs3forclient.svn.path}/UserContext.java" dest="${basedir}/tmp/UserContext.java" />
  <get src="${gs3forclient.svn.path}/GSXML.java" dest="${basedir}/tmp/GSXML.java" />
  <get src="${gs3forclient.svn.path}/XMLConverter.java" dest="${basedir}/tmp/XMLConverter.java" />
  <get src="${gs3forclient.svn.path}/GSPath.java" dest="${basedir}/tmp/GSPath.java" />
  <get src="${gs3forclient.svn.path}/MyNodeList.java" dest="${basedir}/tmp/MyNodeList.java" />
  <!-- compile it up: specifying the file to be compiled explicitly --> 
  <javac srcdir="${basedir}/tmp" destdir="${basedir}/tmp" debug="on" debuglevel="lines,vars,source">
    <classpath refid="project.classpath"/>
    <include name="**/*.java"/>
  </javac>  
  <!-- jar it up (without the java files), placing the jar in the lib folder -->    
  <jar destfile="lib/${gs3.files.jar}" basedir="tmp/" excludes="tmp/*.java" />
  <delete dir="tmp" />
</target>

<!-- Targets to generate the project-specific jar files QBRdata.jar and fedoraGS3.jar -->
<target name="QBRdatajar" description="Compiles and creates the QBRdata.jar file needed by GS3demo-client">
   <javac srcdir="${democlient.rootdir}/${QBRdata.rel.path}" debug="on" debuglevel="lines,vars,source">
      <classpath refid="project.classpath"/>
   </javac>
   <jar destfile="lib/QBRdata.jar"
     basedir="${democlient.rootdir}/"
     excludes="${gui.rel.path}/*.*,${dlservices.rel.path}/**,${gs3services.rel.path}/**">
   </jar>
</target>

<target name="fedoraGS3jar" description="Compiles and creates the fedoraGS3.jar file needed by GS3demo-client">
   <javac srcdir="${fedorags3.rootdir}" debug="on" debuglevel="lines,vars,source">
      <classpath refid="project.classpath"/>
   </javac>
   <jar destfile="lib/fedoraGS3.jar"
     basedir="${fedorags3.rootdir}/"/>
</target>

<!-- Target to generate the standalone (reusable) jar files DLservices.jar -->
<target name="DLservicesjar" description="Compiles and creates the DLservices.jar standalone, reusable library file">
   <javac srcdir="${democlient.rootdir}/${dlservices.rel.path}" debug="on" debuglevel="lines,vars,source">
      <classpath refid="project.classpath"/>
   </javac>
   <jar destfile="lib/DLservices.jar"
     basedir="${democlient.rootdir}/"
     excludes="${gui.rel.path}/*.*,${QBRdata.rel.path}/**,${gs3services.rel.path}/**">
   </jar>
</target>

<!-- Target that generates the GSearchInstaller jar file -->
<target name="GSearchInstallerjar" description="Compiles and creates the jar file for the stand-alone GSearchInstaller application">
   <javac srcdir="${gsearchinstaller.rootdir}" debug="on" debuglevel="lines,vars,source" />
   <jar destfile="GSearchInstaller.jar"
     basedir="${gsearchinstaller.rootdir}/"
     manifest="${gsearchinstaller.rootdir}/Manifest.MF"/>
</target>

<!-- Targets that check for and ensure the existence of project-specific jar files -->
<target name="check-QBRdata-jar" description="Checks for existence of dependency file QBRdata.jar">
    <condition property="QBRdata.exists">
    <available file="${basedir}/lib/QBRdata.jar"/>
    </condition>
</target>

<target name="ensure-QBRdata-jar" description="Will generate QBRdata.jar if it did not exist" depends="check-QBRdata-jar" unless="QBRdata.exists">
    <antcall target="QBRdatajar"/>
</target>

<target name="check-fedoraGS3-jar" description="Checks for existence of dependency file fedoraGS3.jar">
    <condition property="fedoraGS3.exists">
    <available file="${basedir}/lib/fedoraGS3.jar"/>
    </condition>
</target>

<target name="ensure-fedoraGS3-jar" description="Will generate fedoraGS3.jar if it did not exist" depends="check-fedoraGS3-jar" unless="fedoraGS3.exists">
    <antcall target="fedoraGS3jar"/>
</target>

<!-- generates the project's executable -->
<target name="check-exec-jar" description="Checks for existence of executable file ${exec.jar.name}">
    <condition property="executable.exists">
    <available file="${basedir}/${exec.jar.name}"/>
    </condition>
</target>

<target name="ensure-exec-jar" description="Will generate ${exec.jar.name} if it did not exist" depends="check-exec-jar" unless="executable.exists">
    <antcall target="build-demo-client"/>
</target>

<!-- Targets that check for and ensure the existence of standalone application GSearchInstaller.jar -->
<target name="check-gsearchinstall-jar" description="Checks for existence of stand-alone application GSearchInstaller.jar">
    <condition property="gsearchinstaller.exists">
    <available file="GSearchInstaller.jar"/>
    </condition>
</target>

<target name="ensure-gsearchinstall-jar" description="Will generate GSearchInstaller.jar if it did not exist" depends="check-gsearchinstall-jar" unless="gsearchinstaller.exists">
    <antcall target="GSearchInstallerjar"/>
</target>

<!-- User input for generating compressed output file for one of the chosen file types. A choice of zip, tar.gz (tar gzip), or tar.bz2 (tar bzip)-->
<target name="create-targzip" if="zip.type" description="User chose to create a tar.gz file of the project">
   <tar destfile="${dist}/${dist.zip.name}.tar.gz" compression="gzip" longfile="gnu"> 
     <tarfileset dir="${basedir}" prefix="${dist.dir.name}" excludes="${zip.excludes}" />
   </tar>
   <echo>If the filepaths are longer than 100 characters, GNU compatible tar commands are necessary to untar the tar.gz</echo>
</target>

<target name="create-tarbzip" if="zip.type" description="User chose to create a tar.bz2 file of the project">
    <tar destfile="${dist}/${dist.zip.name}.tar.bz2" compression="bzip2" longfile="gnu"> 
      <tarfileset dir="${basedir}" prefix="${dist.dir.name}" excludes="${zip.excludes}" />
    </tar>
    <echo>If the filepaths are longer than 100 characters, GNU compatible tar commands are necessary to untar the tar.gz</echo>
</target>

<target name="create-zip" if="zip.type" description="User chose to create a zip file of the project">
    <zip destfile="${dist}/${dist.zip.name}.zip">
       <zipfileset dir="${basedir}" prefix="${dist.dir.name}" excludes="${zip.excludes}" />
    </zip>
</target>

<target name="get-zipformat"> 
<!--<input addproperty="zip.type" validargs="zip,gzip,bzip">--><!-- doesn't work with default value-->
    <input addproperty="zip.format" defaultvalue="zip">What type of compressed output file do you want to generate?
Type one of: zip, tar.gz, tar.bz2
Press enter for default: zip /></input>
    <condition property="zip.type" value="targzip"> 
      <equals arg1="tar.gz" arg2="${zip.format}"/>
    </condition>
    <condition property="zip.type" value="zip"> 
      <equals arg1="zip" arg2="${zip.format}"/>
    </condition>
    <condition property="zip.type" value="tarbzip">
      <equals arg1="tar.bz2" arg2="${zip.format}"/>
    </condition>
    <echo>You chose output file type: ${zip.type}</echo>
  </target>
</project>