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