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   <!-- If you want to use the very good jikes compiler, uncomment this -->
  63   <!-- <property name="build.compiler"   value="jikes"/>-->
  64
  65
  66 <!-- No customization required after this line -->
  67
  68   <property environment="env"/>
  69   <property name="dist.home"      value="${deploy.home}"/>
  70   <property name="deploy.webinf"  value="${deploy.home}/WEB-INF"/>
  71   <property name="deploy.classes" value="${deploy.webinf}/classes"/>
  72   <property name="dist.src"       value="${app.name}.jar"/>
  73   <property name="dist.war"       value="${app.name}.war"/>
  74   <property name="javadoc.home"   value="${deploy.home}/javadoc"/>
  75   <property name="tomcat.home"    value="${env.TOMCAT_HOME}"/>
  76
  77
  78
  79   <!-- Construct the classpath -->
  80   <path id="project.class.path">
  81     <pathelement path="${deploy.home}"/>
  82     <pathelement path="${deploy.classes}"/>
  83     <pathelement path="source"/>
  84     <fileset dir="lib">
  85       <include name="*.jar"/>
  86     </fileset>
  87     <pathelement path="${tomcat.home}/lib/tomcat.jar"/>
  88   <!-- for libs shared between tomcat and webapps (tomcat 3.3.x) -->
  89         <fileset dir="${tomcat.home}">
  90                 <include name="lib/common/*.jar" />
  91         </fileset>
  92   <!-- for libs shared between webapps (tomcat 3.3.x) -->
  93         <fileset dir="${tomcat.home}">
  94                 <include name="lib/apps/*.jar" />
  95         </fileset>
  96   <!-- for libs shared between tomcat and webapps (tomcat 4.0.x) -->
  97         <fileset dir="${tomcat.home}">
  98                 <include name="common/lib/*.jar" />
  99         </fileset>
 100   <!-- for libs shared between webapps (tomcat 4.0.x) -->
 101         <fileset dir="${tomcat.home}">
 102                 <include name="lib/*.jar" />
 103         </fileset>
 104   </path>
 105
 106
 107
 108 <!-- The "prepare" target is used to construct the deployment home
 109      directory structure (if necessary), and to copy in static files
 110      as required.  In the example below, Ant is instructed to create
 111      the deployment directory, copy the contents of the "web/" source
 112      hierarchy, and set up the WEB-INF subdirectory appropriately.
 113 -->
 114
 115   <target name="prepare">
 116     <mkdir  dir="${deploy.home}"/>
 117     <copy todir="${deploy.home}">
 118       <fileset dir="web"/>
 119     </copy>
 120     <mkdir  dir="${deploy.home}/templates"/>
 121     <copy todir="${deploy.home}/templates">
 122       <fileset dir="templates"/>
 123     </copy>
 124     <!--??? why do we need the source in deployment? - br1
 125     <mkdir  dir="${deploy.home}/src"/>
 126     <copy todir="${deploy.home}/src">
 127       <fileset dir="source"/>
 128     </copy>
 129     -->
 130
 131     <mkdir  dir="${deploy.home}/WEB-INF"/>
 132     <copy  file="etc/web.xml"          tofile="${deploy.home}/WEB-INF/web.xml"/>
 133     <mkdir  dir="${deploy.classes}"/>
 134     <mkdir  dir="${deploy.home}/WEB-INF/lib"/>
 135     <copy todir="${deploy.home}/WEB-INF/lib">
 136       <fileset dir="lib">
 137         <exclude name="ant.jar"/>
 138         <exclude name="xerces.jar"/>
 139       </fileset>
 140     </copy>
 141     <mkdir  dir="${javadoc.home}"/>
 142     <mkdir  dir="${deploy.home}/log"/>
 143
 144   </target>
 145
 146
 147
 148 <!-- The "clean" target removes the deployment home directory structure,
 149      so that the next time the "compile" target is requested, it will need
 150      to compile everything from scratch.
 151 -->
 152
 153
 154   <target name="clean">
 155     <delete dir="${deploy.classes}"/>
 156         <mkdir dir="${deploy.classes}"/>
 157   </target>
 158
 159
 160
 161 <!-- The "mrproper" target removes the entire deploy dir - including all
 162         built pages and images.
 163 -->
 164
 165   <target name="mrproper">
 166     <delete dir="${deploy.home}"/>
 167   </target>
 168
 169   <!-- drop out if $TOMCAT_HOME is not set>-->
 170   <target name="testtomcat" unless="tomcat.present">
 171     <fail message="the $$TOMCAT_HOME environment variable is not set or is set to the wrong path. Please set it first. giving up!"/>
 172   </target>
 173
 174 <!-- The "compile" target is used to compile (or recompile) the Java classes
 175      that make up this web application.  The recommended source code directory
 176      structure makes this very easy because the <javac> task automatically
 177      works its way down a source code hierarchy and compiles any class that
 178      has not yet been compiled, or where the source file is newer than the
 179      class file.
 180
 181      Feel free to adjust the compilation option parameters (debug,
 182      optimize, and deprecation) to suit your requirements.  It is also
 183      possible to base them on properties, so that you can adjust this
 184      behavior at runtime.
 185
 186      The "compile" task depends on the "prepare" task, so the deployment
 187      home directory structure will be created if needed the first time.
 188 -->
 189
 190   <target name="compile" depends="prepare">
 191     <!-- check to see if $TOMCAT_HOME was set to something useful.. -->
 192     <available file="${tomcat.home}/conf" property="tomcat.present"/>
 193     <antcall target="testtomcat"/>
 194
 195     <!--<antcall target="clean"/>-->
 196     <dependset>
 197       <srcfileset
 198         dir="source"
 199         includes="**/*.java"/>
 200       <srcfileset
 201         dir="lib"
 202         includes="*.jar"/>
 203       <targetfileset
 204         dir="${deploy.classes}"
 205         includes="**/*.class"/>
 206     </dependset>
 207     <javac srcdir="source" destdir="${deploy.classes}"
 208            debug="on" optimize="off" deprecation="on">
 209       <classpath refid="project.class.path"/>
 210     </javac>
 211     <copy   todir="${deploy.classes}">
 212       <fileset dir="source" includes="**/*.properties"/>
 213     </copy>
 214     <copy   todir="${deploy.home}">
 215       <fileset dir="source" includes="**/content-types.properties"/>
 216       <!-- server.xml is currently not used
 217       <fileset dir="source" includes="**/server.xml"/>
 218       -->
 219     </copy>
 220     <copy   todir="${deploy.classes}/bundles">
 221       <fileset dir="bundles" includes="**/*.properties"/>
 222     </copy>
 223   </target>
 224
 225
 226
 227   <target name="perms">
 228         <exec executable="./perms.sh"/>
 229   </target>
 230
 231
 232 <!-- The "javadoc" target is used to create the Javadoc API documentation
 233      for the Java classes in this web application.  It is assumed that
 234      this documentation is included in the deployed application, so the
 235      example below generates the Javadoc HTML files in a subdirectory under
 236      the deployment home directory.  Feel free to customize the options for
 237      the JavaDoc task, after consulting the Ant documentation.
 238 -->
 239
 240   <target name="javadoc" depends="prepare">
 241     <javadoc packagenames="mir.*, mircoders.*"
 242              sourcefiles="source/${app.name}.java,source/Open${app.name}.java"
 243              sourcepath="source"
 244              destdir="${javadoc.home}">
 245           <classpath refid="project.class.path"/>
 246         </javadoc>
 247   </target>
 248
 249
 250 <!-- The "all" target rebuilds everything by executing the "clean"
 251      target first, which forces the "compile" target to compile all
 252      source code instead of just the files that have been changed.
 253 -->
 254
 255   <target name="all" depends="clean,prepare,compile,javadoc"/>
 256
 257
 258 <!-- The "dist" target builds the distribution Web ARchive (WAR) file
 259      for this application, suitable for distribution to sites that wish
 260      to install your application.  It also creates a JAR file containing
 261      the source code for this application, if you wish to distribute
 262      that separately.
 263 -->
 264   <target name="dist" depends="prepare,compile">
 265     <jar jarfile="${dist.home}/mirbase.jar"
 266          includes="mir/**"
 267          basedir="${deploy.classes}"/>
 268     <jar jarfile="${dist.home}/${dist.src}"
 269          basedir="./source"/>
 270     <jar jarfile="${dist.home}/${dist.war}"
 271          basedir="${deploy.home}"
 272          excludes="${dist.war}"/>
 273   </target>
 274
 275 </project>