build.xml

   1 <project name="Mir" default="compile" basedir=".">
   2
   3
   4 <!-- What this file is all about
   5
   6      You can use this version of build.xml to use directly with ant
   7      i.e. without the build.sh script. Simply call ant and let it all
   8      happen.
   9 -->
  10
  11 <!-- Property Definitions
  12
  13      Please not that only the first couple of properties have to be defined.
  14      The rest, residing below the "no customization needed" line may be
  15      customized if you know what you are doing. Else, leave the defaults
  16      and use them to look up where ant places all the files.
  17
  18      app.name          Base name of this application, used to
  19                        construct filenames and directories.
  20
  21      deploy.home       The name of the directory into which the
  22                        deployment hierarchy will be created.
  23                        Normally, this will be the name of a
  24                        subdirectory under $TOMCAT_HOME/webapps.
  25
  26      deploy.classes    The name of the directory that will contain
  27                        the class files.
  28
  29      dist.home         The name of the base directory in which
  30                        distribution files are created.
  31
  32      dist.src          The name of the distribution JAR file
  33                        containing the application source code,
  34                        to be stored in the "dist.home" directory.
  35                        This filename should end with ".jar".
  36
  37      dist.war          The name of the Web ARchive (WAR) file
  38                        containing our deployable application.
  39                        This filename should end with ".war".
  40
  41      javadoc.home      The name of the base directory in which
  42                        the JavaDoc documentation for this application
  43                        is generated.
  44
  45      tomcat.home       The name of the base directory in which
  46                        Tomcat has been installed.  This value is
  47                        normally set automatically from the value
  48                        of the TOMCAT_HOME environment variable.
  49
  50         java.home          The location of your Java SDK.
  51
  52         java.localhome     Where your local java classes and jar files
  53                        are located.
  54
  55         tomcat.home        The location of the tomcat root directory.
  56
  57 -->
  58
  59   <property name="app.name"       value="Mir"/>
  60   <property name="deploy.home"    value="../${app.name}"/>
  61
  62
  63 <!-- No customization required after this line -->
  64
  65   <property name="dist.home"      value="${deploy.home}"/>
  66   <property name="deploy.webinf"  value="${deploy.home}/WEB-INF"/>
  67   <property name="deploy.classes" value="${deploy.webinf}/classes"/>
  68   <property name="dist.src"       value="${app.name}.jar"/>
  69   <property name="dist.war"       value="${app.name}.war"/>
  70   <property name="javadoc.home"   value="${deploy.home}/javadoc"/>
  71
  72   <!-- If you want to use the very good jikes compiler, uncomment this
  73   <property name="build.compiler"   value="jikes"/>-->
  74
  75   <!-- The following 3 properties seem redundant -->
  76   <property name="java.home"      value="/usr/lib/j2sdk1.3/"/>
  77   <property name="java.localhome" value="/usr/share/java/"/>
  78   <property name="tomcat.home"    value="/usr/share/tomcat/"/>
  79
  80
  81   <!-- Construct the classpath -->
  82   <path id="project.class.path">
  83     <pathelement path="${deploy.home}"/>
  84     <pathelement path="${deploy.classes}"/>
  85     <pathelement path="source"/>
  86     <fileset dir="lib">
  87       <include name="*.jar"/>
  88     </fileset>
  89 <!--    <fileset dir="${java.home}/lib">
  90       <include name="tools.jar"/>
  91       <include name="rt.jar"/>
  92     </fileset>
  93     <fileset dir="${java.localhome}">
  94       <include name="*.jar"/>
  95     </fileset>
  96     <pathelement path="${tomcat.home}/lib/tomcat.jar"/>
  97 -->
  98   </path>
  99
 100
 101
 102 <!-- The "prepare" target is used to construct the deployment home
 103      directory structure (if necessary), and to copy in static files
 104      as required.  In the example below, Ant is instructed to create
 105      the deployment directory, copy the contents of the "web/" source
 106      hierarchy, and set up the WEB-INF subdirectory appropriately.
 107 -->
 108
 109   <target name="prepare">
 110     <mkdir  dir="${deploy.home}"/>
 111     <copy todir="${deploy.home}">
 112       <fileset dir="web"/>
 113     </copy>
 114     <mkdir  dir="${deploy.home}/templates"/>
 115     <copy todir="${deploy.home}/templates">
 116       <fileset dir="templates"/>
 117     </copy>
 118     <mkdir  dir="${deploy.home}/src"/>
 119     <copy todir="${deploy.home}/src">
 120       <fileset dir="source"/>
 121     </copy>
 122
 123     <mkdir  dir="${deploy.home}/WEB-INF"/>
 124     <copy  file="etc/web.xml"          tofile="${deploy.home}/WEB-INF/web.xml"/>
 125     <mkdir  dir="${deploy.classes}"/>
 126     <mkdir  dir="${deploy.home}/WEB-INF/lib"/>
 127     <copy todir="${deploy.home}/WEB-INF/lib">
 128       <fileset dir="lib">
 129         <exclude name="ant.jar"/>
 130         <exclude name="xerces.jar"/>
 131       </fileset>
 132     </copy>
 133     <mkdir  dir="${javadoc.home}"/>
 134     <mkdir  dir="${deploy.home}/log"/>
 135
 136   </target>
 137
 138
 139
 140 <!-- The "clean" target removes the deployment home directory structure,
 141      so that the next time the "compile" target is requested, it will need
 142      to compile everything from scratch.
 143 -->
 144
 145
 146   <target name="clean">
 147     <delete dir="${deploy.classes}"/>
 148         <mkdir dir="${deploy.classes}"/>
 149   </target>
 150
 151
 152
 153 <!-- The "mrproper" target removes the entire deploy dir - including all
 154         built pages and images.
 155 -->
 156
 157   <target name="mrproper">
 158     <delete dir="${deploy.home}"/>
 159   </target>
 160
 161
 162
 163 <!-- The "compile" target is used to compile (or recompile) the Java classes
 164      that make up this web application.  The recommended source code directory
 165      structure makes this very easy because the <javac> task automatically
 166      works its way down a source code hierarchy and compiles any class that
 167      has not yet been compiled, or where the source file is newer than the
 168      class file.
 169
 170      Feel free to adjust the compilation option parameters (debug,
 171      optimize, and deprecation) to suit your requirements.  It is also
 172      possible to base them on properties, so that you can adjust this
 173      behavior at runtime.
 174
 175      The "compile" task depends on the "prepare" task, so the deployment
 176      home directory structure will be created if needed the first time.
 177 -->
 178
 179   <target name="compile" depends="prepare">
 180         <antcall target="clean"/>
 181     <javac srcdir="source" destdir="${deploy.classes}"
 182            debug="on" optimize="off" deprecation="on">
 183       <classpath refid="project.class.path"/>
 184         </javac>
 185     <copy   todir="${deploy.classes}">
 186       <fileset dir="source" includes="**/*.properties"/>
 187     </copy>
 188     <copy   todir="${deploy.home}">
 189       <fileset dir="source" includes="**/content-types.properties"/>
 190       <fileset dir="source" includes="**/server.xml"/>
 191     </copy>
 192     <copy   todir="${deploy.classes}/bundles">
 193       <fileset dir="bundles" includes="**/*.properties"/>
 194     </copy>
 195   <!-- I really don't think this is needed by default. maybe make it a targe?
 196     -mh -->
 197         <!--<exec executable="./perms.sh"/>-->
 198   </target>
 199
 200
 201 <!-- The "javadoc" target is used to create the Javadoc API documentation
 202      for the Java classes in this web application.  It is assumed that
 203      this documentation is included in the deployed application, so the
 204      example below generates the Javadoc HTML files in a subdirectory under
 205      the deployment home directory.  Feel free to customize the options for
 206      the JavaDoc task, after consulting the Ant documentation.
 207 -->
 208
 209   <target name="javadoc" depends="prepare">
 210     <javadoc packagenames="mir.*, mircoders.*"
 211              sourcefiles="source/${app.name}.java,source/Open${app.name}.java"
 212              sourcepath="source"
 213              destdir="${javadoc.home}">
 214           <classpath refid="project.class.path"/>
 215         </javadoc>
 216   </target>
 217
 218
 219 <!-- The "all" target rebuilds everything by executing the "clean"
 220      target first, which forces the "compile" target to compile all
 221      source code instead of just the files that have been changed.
 222 -->
 223
 224   <target name="all" depends="clean,prepare,compile,javadoc"/>
 225
 226
 227 <!-- The "dist" target builds the distribution Web ARchive (WAR) file
 228      for this application, suitable for distribution to sites that wish
 229      to install your application.  It also creates a JAR file containing
 230      the source code for this application, if you wish to distribute
 231      that separately.
 232 -->
 233   <target name="dist" depends="prepare,compile">
 234     <jar jarfile="${dist.home}/mirbase.jar"
 235          includes="mir/**"
 236          basedir="${deploy.classes}"/>
 237     <jar jarfile="${dist.home}/${dist.src}"
 238          basedir="./source"/>
 239     <jar jarfile="${dist.home}/${dist.war}"
 240          basedir="${deploy.home}"
 241          excludes="${dist.war}"/>
 242   </target>
 243
 244 </project>