source: other-projects/the-macronizer/trunk/build.xml@ 33865

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<project basedir="." default="war" name="TheMacronizer">

  <property environment="env"/>
  <!--
      the associated Greenstone 3 installation folder
      You're expected to run/source the gs3-setup script in the GS3
      before running the default ant target in this file.
      You will be warned of this if you attempt to run this ant
      build.xml file without doing gs3-setup.
  -->
  <property name="gsdl3.web.home" value="${env.GSDL3HOME}"/>
  <property name="gsdl3.src.home" value="${env.GSDL3SRCHOME}"/>
  
  <property name="dist.dir.exp" location="releases" />
  
  <property name="dist.filename.exp"   value="TheMacronizer.war" />
  <property name="build.dir.exp"   location="web" />
  <property name="lib.dir.exp"  location="web/WEB-INF/lib" />
  <property name="webinf.dir"  location="web/WEB-INF" />
  <!-- Properties for MacroniserLogFileProcessor, use FULL PATHS -->
  <property name="scripts.dir" location="${basedir}/src/scripts-and-sql" />
  <property name="logfileproc.dir" value="${basedir}/logproc"/>
  
  <!--
      If changing these values, make sure you run 'ant clean'
  -->
  <property name="javac.source" value="1.8" />
  <property name="javac.target" value="${javac.source}" />
  <property name="javac.debug"  value="true" />


  <path id="classpath.exp">
    <fileset dir="${lib.dir.exp}">
    <include name="*.jar" />
    </fileset>
  </path>
    
  
  <target name="clean">
    <!-- delete only the class files built by themacronizer -->
    <delete dir="${build.dir.exp}/WEB-INF/classes"/>
  </target>

  
  <target name="init">
    <!-- has the gs3-setup script been run?? -->
    <condition property="gs3-setup-not-done">
      <not>
    <isset property="env.GSDL3HOME"/>
      </not>
    </condition>
    <fail if="gs3-setup-not-done" message="Please run 'gs3-setup' (Windows) or 'source gs3-setup.sh' (Linux/Mac) in the Greenstone3 installation that's associated with this Macronizer installation before this step."/>

    
    <echo message="${ant.project.name}: ${ant.file}"/>
    <mkdir dir="${build.dir.exp}/WEB-INF/classes"/>
    <mkdir dir="${build.dir.exp}/WEB-INF/classes/monogram"/>
    <copy includeemptydirs="false" todir="${build.dir.exp}/WEB-INF/classes/monogram/data">
      <fileset dir="src/java/monogram/data" />
    </copy>
  </target>
    
  <target name="build" depends="init">
    <javac source="${javac.source}" target="${javac.target}" debug="${javac.debug}"
       encoding="utf-8"
           destdir="${build.dir.exp}/WEB-INF/classes" includeantruntime="false">                                
      <src path="src"/>
            
      <classpath>
    <path refid="classpath.exp"/>
    <pathelement location="src/jars/servlet-api.jar"/>
    <pathelement path="src/java"/>
    <pathelement path="webinf.dir"/>
      </classpath>
    </javac>

    <!-- http://ant.apache.org/manual/Tasks/copy.html
     By default, files are only copied if the source file is newer than the destination file,
     or when the destination file does not exist. However, you can explicitly overwrite files
     with the overwrite attribute.-->
    
    <filter token="macronizer.home" value="${basedir}"/>

    <!-- 1a. Create the log4j.properties file from its log4j.properties.in template file and put it into the *Macronizer* installation's web/WEB-INF/classes folder -->
    <copy file="${build.dir.exp}/log4j.properties.in" tofile="${build.dir.exp}/WEB-INF/classes/log4j.properties" filtering="true" overwrite="true"/>
    
    <!-- 1b. Create the mysql.props file -->
    <copy file="${build.dir.exp}/mysql.properties.in" tofile="${build.dir.exp}/WEB-INF/classes/mysql.properties" filtering="true" overwrite="true"/>

    <!-- TODO: Ask Ryan Ko if the following message is fit to be known in public:
     <echo>Make sure to change the mysql db.password property in WEB-INF/classes/mysql.properties</echo>
    -->

    <!-- 2. Create the macronizer.xml tomcat context file from the macronizer.xml.in template file and put it into the correct location in the associated GS3 installation -->
    <copy file="${build.dir.exp}/macronizer.xml.in" tofile="${gsdl3.src.home}/packages/tomcat/conf/Catalina/localhost/macron-restoration.xml" filtering="true" overwrite="true"/>
    
    <!-- mkdir Creates a directory. Also non-existent parent directories are created,
     when necessary. Does nothing if the directory already exist. -->
    <mkdir dir="${build.dir.exp}/logs"/>

    <!-- For the MacroniserFileLogProcessor, which sets up a nightly cron to send useful logging info
     from the daily macron.log.<date> files to a mysqldb, need to do some setup too -->
    <copy file="${build.dir.exp}/mysql.properties.in" tofile="${basedir}/mysql.properties" filtering="true" overwrite="true"/>
    
    <mkdir dir="${logfileproc.dir}"/>
    
    <filter token="macronizer.scripts" value="${scripts.dir}"/>
    <filter token="macronizer.logs" value="${build.dir.exp}/logs"/>
    <copy file="${basedir}/src/scripts-and-sql/cron.in" tofile="${basedir}/src/scripts-and-sql/cron.txt" filtering="true" overwrite="true"/>

    <filter token="logfileproc.exec_folder" value="${build.dir.exp}/WEB-INF/classes"/> <!-- where the util.MacroniserLogProcessor compiled code is -->
    <filter token="logfileproc.dir" value="${logfileproc.dir}"/>
    <filter token="jarlibs.folder" value="${build.dir.exp}/WEB-INF/lib"/>
    <filter token="classes.folder" value="${build.dir.exp}/WEB-INF/classes"/>
    <!-- Why can't we set the classpath to the mysql.properties file
     to be anywhere other than the toplevel Macronizer folder/basedir?
     Anything else causes class MySQLAccess of MacroniserLogFileProcessor
     to fail with mysql.properties FileNotFoundException -->
    <!--<filter token="mysqlprops.dir" value="${logfileproc.dir}"/>-->
    <filter token="mysqlprops.dir" value="${basedir}"/>
    
    <copy file="${scripts.dir}/macronLogToDB.bash.in" tofile="${scripts.dir}/macronLogToDB.bash" filtering="true" overwrite="true"/>
    <chmod file="${scripts.dir}/macronLogToDB.bash" perm="ugo+rx"/>
    
    <echo>*** Run the ant target 'ant logs-to-db-instructions' for instructions on setting up the MacroniserLogFileProcessor***</echo>
  </target>

  <target name="logs-to-db-instructions">
    <echo>      ************************************************************
      Instructions on setting up the MacroniserLogFileProcessor
      ************************************************************
      
      1. Install mysql-5.7.23 as instructed at
      http://wiki.greenstone.org/doku.php?id=en:user_advanced:greenstonesqlplugs#getting_and_running_mysql
      (And when you run that mysql installation's db server, shut it down or run its mysql client,
      do so as per the instructions there)

      2. Use separate terminals to use the above instructions link to:
        - Start the mysql server
        - Connect to the mysql client
      
      3. After connecting to the client, in the mysql client terminal
        - IMPORTANT: don't forget to immediately follow with 'set names utf8mb4;'
        - CREATE AND INITIALISE the Macroniser database and its tables by running
    the MySQL_Code.sql script by typing the following and hitting ENTER:
            source ${scripts.dir}/MySQL_Code.sql
      
      3. Edit ${basedir}/mysql.properties to set the db password.
        - If you set up a different username for the mysql db, set that in mysql.properties too.
        - If nothing is set, MacronLogFileProcessor will assume the username is root.   

      4. Set up the daily cronjob as follows:
        - open a terminal and type 'export EDITOR=emacs' (or set to the text editor you prefer)
    - type 'crontab -e' and the editor will open the cronfile
    - append the contents from ${scripts.dir}/cron.txt to the cronfile
    - save file and exit the editor

      5. If you have email rights on the linux you're working from,
         type your email into macronLogToDB.bash.in and macronLogToDB.bash
         to get sent emails on errors.

      6. All going well, you should get output files in the ${logfileproc.dir}
     folder after the cron job runs each night.
    
      ************************************************************
    </echo>
  </target>
  
  <target name="war" depends="build">
    <echo>Basedir: ${basedir}</echo>
    <jar destfile="${dist.filename.exp}">  
      <fileset dir="${build.dir.exp}" />
    </jar>
  </target>
  
</project>