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